Skip to main content
GET
Get submission result

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.

Path Parameters

id
string
required

The submission_id returned when the submission was created.

Query Parameters

sections
enum<string>[]

Comma-separated list of design-system sections to include, e.g. ?sections=colors,typography. Omit for all originally requested sections. This only filters the existing result and never runs extraction work or adds sections omitted from the original submission. Only result.design_system is filtered: the envelope, including its original sections selection, and result.artifacts are always returned. An unknown section name returns 422. For a brand kit, use its own section names, such as ?sections=colors,buttons; a website section name returns 422.

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

Response

The result envelope. May be partial while later steps complete.

Unified result envelope. May be partial while later steps complete.

submission_id
string
required
status
string
required

Submission status, e.g. completed or failed.

source_url
string<uri>
required
extraction_id
string | null

Identifier of the extraction this submission produced. null until one exists.

current_step
string
step_started_at
string<date-time> | null
updated_at
string<date-time>
result_updated_at
string<date-time>
cache_hit
boolean

Whether the result was served from cache. When true, completed_at reflects the original extraction, not this request.

accepted_at
string<date-time>
completed_at
string<date-time> | null

When the extraction completed: the freshness of the result. On a cache hit (cache_hit is true) this is the original extraction, not the current request, so it may predate this request. null while the submission is still running.

result
object
sections
enum<string>[] | null

The original extraction selection, with duplicates removed. Null identifies a full extraction. This value is unchanged by GET result filtering. Completed selective results contain only the requested sections and are never eligible cache sources.

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: