Get Thread Status

Beta
Check the status of a thread execution by thread ID. Returns thread status and associated conversation asset information for tracking progress.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

thread_idstringRequired
The unique thread ID to check status for

Query parameters

include_messagesboolean or nullOptional
Whether to materialize checkpoint messages. By default, deployments with lightweight active reads enabled omit messages while a run is scheduled, queued, or running, and include them once it is terminal. Set true to force messages or false to skip them.

Response

Thread status retrieved successfully
conversation_assetobject or null
Information about the associated conversation asset
created_atstring
ISO timestamp when thread was created
statusstring

Current status of the thread (e.g., ‘running’, ‘completed’, ‘failed’)

thread_idstring
The thread ID that was checked
updated_atstring
ISO timestamp when thread was last updated
errorstring or nullOptional
Error message if thread execution failed

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error