Run a single extractor
curl --request POST \
--url https://api.example.com/v1/design/extract/{extractor} \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"endUserId": "<string>",
"enableIpRotation": true
}
'import requests
url = "https://api.example.com/v1/design/extract/{extractor}"
payload = {
"url": "<string>",
"endUserId": "<string>",
"enableIpRotation": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', endUserId: '<string>', enableIpRotation: true})
};
fetch('https://api.example.com/v1/design/extract/{extractor}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/design/extract/{extractor}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'endUserId' => '<string>',
'enableIpRotation' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/design/extract/{extractor}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"endUserId\": \"<string>\",\n \"enableIpRotation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/design/extract/{extractor}")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"endUserId\": \"<string>\",\n \"enableIpRotation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/design/extract/{extractor}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"endUserId\": \"<string>\",\n \"enableIpRotation\": true\n}"
response = http.request(request)
puts response.read_bodyDesign extraction
Run a single extractor
Path-scoped alias of POST /v1/design/extract that runs exactly one extractor. Useful when you only need fonts or only need colors and don’t want to filter the response client-side.
POST
/
v1
/
design
/
extract
/
{extractor}
Run a single extractor
curl --request POST \
--url https://api.example.com/v1/design/extract/{extractor} \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"endUserId": "<string>",
"enableIpRotation": true
}
'import requests
url = "https://api.example.com/v1/design/extract/{extractor}"
payload = {
"url": "<string>",
"endUserId": "<string>",
"enableIpRotation": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', endUserId: '<string>', enableIpRotation: true})
};
fetch('https://api.example.com/v1/design/extract/{extractor}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/design/extract/{extractor}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'endUserId' => '<string>',
'enableIpRotation' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/design/extract/{extractor}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"endUserId\": \"<string>\",\n \"enableIpRotation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/design/extract/{extractor}")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"endUserId\": \"<string>\",\n \"enableIpRotation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/design/extract/{extractor}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"endUserId\": \"<string>\",\n \"enableIpRotation\": true\n}"
response = http.request(request)
puts response.read_bodyThis endpoint is identical to
Response —
Same shape as
Poll
POST /v1/design/extract with extractors: ["<extractor>"] — it just lets you encode the extractor in the path so URL-based routing, audit logs, and dashboards group cleanly by extractor type.
Path parameters
string
required
One of:
images, fonts, colors, icons, tokens, logo. An unknown value returns 400.Request body
string
required
The page to extract from. Must be
http:// or https://.string
required
Opaque identifier for the user this extraction runs on behalf of. ≤ 256 characters.
boolean
Optional. Defaults to
false. When true, the browser session is launched through the residential proxy/IP rotation pool.The body’s
extractors field, if passed, is ignored on this endpoint — the path parameter wins.Response — 202 Accepted
Same shape as POST /v1/design/extract. The returned extractors array always contains exactly the path-supplied extractor.
When to use this vs the combined endpoint
This is just a routing alias. From the SDK, it’s usually simpler to callclient.design.run({ ..., extractors: ["colors"] }) against the combined endpoint — same result, one fewer URL to remember. Use the path-aliased endpoint when you want the extractor name surfaced in URL-based logs, audit trails, or routing/proxy rules.
Example
# SDK — same client.design.run, just narrow `extractors` to one.
task = client.design.run(
url="https://www.figma.com/",
end_user_id="alice",
extractors=["colors"],
enable_ip_rotation=True,
)
print(task.design["results"]["colors"]["colors"][:3])
const task = await client.design.run({
url: "https://www.figma.com/",
endUserId: "alice",
extractors: ["colors"],
enableIpRotation: true,
});
console.log(task.design?.results.colors);
curl "$API_BASE/design/extract/colors" -X POST \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://www.figma.com/", "endUserId": "alice", "enableIpRotation": true }'
Response
{
"taskId": "7f2a1b8c-...",
"sessionId": "a31d5e9f-...",
"status": "pending",
"extractors": ["colors"],
"enableIpRotation": true,
"createdAt": "2026-05-04T22:11:02Z"
}
GET /v1/tasks/{taskId} for the result — see Submit design extraction → Get-task response.
Errors
| Code | Meaning |
|---|---|
400 | Unknown extractor; url missing or not http(s); endUserId missing or > 256 chars; invalid JSON body |
401 | Missing Authorization header |
403 | Revoked API key |
429 | Monthly task quota exceeded |
500 | Worker enqueue failed (transient; safe to retry) |
