Skip to main content
POST

Authorizations

X-API-Key
string
header
required

API key issued by the Taste Engine. Create one in the dashboard at https://engine.tastelabs.com/app/api-keys.

Query Parameters

map
boolean
default:false

When true, discover and submit multiple URLs from the site instead of just the one provided. Cannot be combined with a sections selection.

max_urls
integer

Maximum number of URLs to discover in map mode. The server clamps this to 200.

Required range: 1 <= x <= 200

Body

application/json
url
string<uri>
required

The URL to extract a design system from.

force
boolean
default:false

Re-run extraction even if a cached result exists.

enable_deep_analysis
boolean
default:false

Run additional, slower analysis steps. Cannot be combined with sections.

sections
enum<string>[] | null

Design-system sections to extract and return. Omit or pass null for a full extraction. Empty arrays and unknown names return 422; duplicates are removed. Cannot be combined with map=true or enable_deep_analysis=true. An explicit list of every section is still a selective extraction. Selecting fewer sections does not change the credit price. Use ["brand_assets"] to extract only brand imagery from ads, social channels, and campaigns.

Minimum array length: 1

A top-level section of result.design_system. Use in the submission body to select extraction work, or in the result query to filter an existing result. The value "sections" means descriptions of the page sections in order.

Available options:
profile,
layout,
colors,
typography,
surfaces,
elevation,
interactions,
actions,
navigation,
data_display,
structure,
icons,
assets,
sections,
brand_assets
Example:

Response

The submission was accepted and queued for processing.

submission_id
string
required
status
enum<string>
required
Available options:
accepted
source_url
string<uri>
required
accepted_at
string<date-time>
required