Skip to content

Get workflow status

GET
/v1/workflows/{workflow_run_id}
curl --request GET \
--url https://dev-api.infiniteaudience.ai/v1/workflows/example \
--header 'Authorization: Bearer <token>'

Returns the current status of a similarity or propensity audience workflow run. Poll this endpoint after creating a similarity or propensity audience to track progress. Use wait_for_workflow (MCP) for a blocking poll, or call this endpoint directly for non-blocking status checks. Requires ‘discovery’ scope.

workflow_run_id
required
string

The workflow run ID returned in the POST /v1/audiences response.

Workflow status.

Media typeapplication/json
object
workflow_run_id
string
status

Running = steps executing normally; paused = waiting for HITL gate response (only when hitl=true); completed = workflow finished, audience is active; failed = workflow encountered an unrecoverable error.

string
Allowed values: running paused completed failed
current_step

Current step index (1-based).

integer
step_count

Total number of steps in the workflow.

integer
paused_gate

Present only when status is paused and hitl=true. Contains gate info for user response.

object
gate_id

Opaque gate identifier — pass to POST /v1/workflows/{workflow_run_id}/resume.

string
message

Human-readable message describing the decision needed.

string
options

Valid response values — pick one and pass as response to the resume endpoint.

Array<string>
Examples

Workflow in progress

{
"workflow_run_id": "wf_abc123",
"status": "running",
"current_step": 2,
"step_count": 5,
"paused_gate": null
}

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
{
"error": "Unauthorized: Missing or invalid Authorization header"
}

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplemissing_scope
{
"error": "SCOPE_REQUIRED",
"message": "This endpoint requires the purchase scope."
}

Resource not found or not accessible to the calling org.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplenot_found
{
"error": "Audience not found"
}