Skip to main content
GET
Get submission

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.

Response

The submission status view.

Status view of a single submission.

submission_id
string
required
status
enum<string>
required

Lifecycle status of a submission.

Available options:
accepted,
queued,
crawling,
extracting,
completed,
failed
source_url
string<uri>
required
is_public
boolean
required

Whether the result is publicly readable.

current_step
string

Name of the step currently running.

step_started_at
string<date-time>
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.

extraction_id
string | null
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.

error
string | null

Error message when status is failed.

credits_consumed
integer | null

Net credits this submission consumed. null when metering was off, and 0 once a failed submission has been refunded.

credit_ref_id
string | null

Reference to the credit charge for this submission.

api_key_name
string | null

Name of the API key that created the submission. null for dashboard submissions and when metering was off at submission time.

batch_id
string | null

Identifier of the batch run this submission belongs to.

batch_label
string | null

Human-readable label for the batch run.

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:
kind
enum<string>

website for a URL extraction, brand_kit for a brand guidelines PDF.

Available options:
website,
brand_kit