v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Basics

Get Response Streaming Status

Returns the state and queue progress of a website's response-streaming run. By default reports the latest run; pass workflow_id to read a specific one. When no run has ever been started, state is idle and the config/progress fields are zeroed or null.

get/api/v1/response-streaming/status

Query parameters

website_idstring uuid required

The ID of the website to read run status for.

workflow_idstring

Read a specific run instead of the latest one.

Response

Current run state and progress

state'idle' | 'running' | 'completed' | 'failed' | 'cancelled' required

workflow_idstring nullable required

created_atstring nullable

updated_atstring nullable

is_scheduledboolean nullable