ATathenahq
Basics

Get Response Streaming Status

Changed on

Returns the whole-run state and response-queue progress of a website's response-streaming run. By default reports the latest run; pass workflow_id to read a specific one. Progress measures response collection only, so state can remain running when progress.percentage is 100 while downstream analysis finishes. Only state: "completed" means the whole run, including downstream analysis, has finished. saved_response_progress separately counts distinct saved responses against the original request, with an immutable first-terminal-outcome snapshot. 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

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

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

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

workflow_idstring nullable required
created_atstring nullable
updated_atstring nullable
is_scheduledboolean nullable
finish_reason'credits_exhausted' | 'credits_paused' | 'subscription_inactive' | 'organization_deleted' | 'entitlement_unreadable' | 'cancelled_by_user' | 'responses_failed' | 'items_stuck' | 'attribute_extraction_failed' | 'workflow_error' | 'stale' nullable

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.

Changes

  • 2d1d86d5e067Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status