Sign in

v1

latestOpenAPI 3.1.02026-07-26221930.5 KB
Dispatch

Get task detail

Get full details for a dispatch task, including the generated API spec with endpoint definitions and execution URLs when completed.

get/dispatch/tasks/{task_id}

Path parameters

task_idstring required

Response

Task detail

idstring
urlstring
taskstring nullable
status'queued' | 'running' | 'needs_input' | 'completed' | 'failed' | 'cancelled'

Task lifecycle state. Poll until it reaches a terminal state: completed, failed, or cancelled.

iterationinteger nullable
user_input_promptobject nullable

Present when status is 'needs_input' — the question(s) the agent needs answered. Respond via POST /dispatch/{task_id}.

result_scraper_idstring nullable

Set on completion — the scraper_id used to execute endpoints.

result_marketplace_idstring nullable
errorstring nullable

Set when status is 'failed'.

created_atstring nullable
updated_atstring nullable
completed_atstring nullable
parent_task_idstring nullable
extends_scraper_idstring nullable
revision_typestring nullable
auth_enabledboolean

True if this API was built against a site that requires login.

source'built' | 'subscribed' | 'forked'

How the user acquired this API.

contributes_to_marketplaceboolean
progressobject

Live build progress while status is 'running' (stage, headline, per-endpoint status, log).

marketplace_apisobject nullable
existing_marketplace_apisobject nullable