Skip to main content
GET
Get Response Streaming Status

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Query Parameters

website_id
string<uuid>
required

The ID of the website to read run status for.

workflow_id
string

Read a specific run instead of the latest one.

Response

Current run state and progress

state
enum<string>
required

Whole-run state. Only completed means the whole run, including downstream analysis, has finished. running can coexist with 100 percent response progress.

Available options:
idle,
running,
completed,
failed,
cancelled
workflow_id
string | null
required
config
object
required
progress
object
required

Measures response collection only. These queue counts do not indicate downstream analysis readiness.

saved_response_progress
object | null
required

Distinct saved responses, not queue attempts or downstream readiness. Null means no original request plan was recorded, including historical runs. Current completion may increase after recovery without changing the original expected count or first-terminal-outcome snapshot.

created_at
string | null
updated_at
string | null
is_scheduled
boolean | null
finish_reason
enum<string> | null

Why a failed or cancelled run ended. credits_exhausted: no credits remaining. credits_paused: credit allocation paused by the partner. subscription_inactive, organization_deleted. entitlement_unreadable: billing could not be read mid-run; pending responses are retried by the backfill. cancelled_by_user. responses_failed: collection finished with failed responses. items_stuck, attribute_extraction_failed, workflow_error, stale. Null while running, for completed runs, and for runs older than this field.

Available options:
credits_exhausted,
credits_paused,
subscription_inactive,
organization_deleted,
entitlement_unreadable,
cancelled_by_user,
responses_failed,
items_stuck,
attribute_extraction_failed,
workflow_error,
stale