Skip to main content
GET
Get a message's delivery and answer

Path Parameters

messageId
string<uuid>
required

Response

200 - application/json

OK

completed
boolean
required

Whether the run has reached a terminal status.

threadId
string<uuid>
required

Thread ID associated with the run.

runId
string<uuid>
required

Run ID for subsequent polling. For a queued follow-up this is the ID its run will start under once the thread's earlier run ends; polling it reports queued until then and never the earlier run's result.

messageId
string<uuid>
required
status
enum<string>
required

Current run lifecycle status. queued: the message is waiting behind the thread's run in flight and has not started; it starts after that run ends, whatever that run's outcome, unless the queued message is cancelled with runs.cancel.

Available options:
queued,
processing,
completed,
aborted,
error
response
string | null
required

Assistant response text when the run has completed.

failureClass
enum<string> | null
required
Available options:
billing_account_missing,
subscription_missing,
subscription_blocked,
credit_balance_missing,
credit_balance_depleted,
billing_admission_unavailable,
permission,
policy,
provider,
provider_rejected,
cancelled,
timeout,
rate_limit,
grpc_message_too_large,
sandbox_concurrency,
sandbox_missing,
sandbox_failed,
tool_failed,
workflow_start_failed,
workflow_died,
unknown
failureRetryable
boolean | null
required

Whether retrying the identical request is worth attempting. Null when there is no answer: the run did not fail, or its failure is unclassified.

delivery
object
required