Skip to main content
POST
Run a single extractor
This endpoint is identical to 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 call client.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

Response
Poll GET /v1/tasks/{taskId} for the result — see Submit design extraction → Get-task response.

Errors