Agents

Get thread status and messages

Changed on

Retrieve the current status and messages of an agent thread.

get/v4/agents/{agent_id}/threads/{thread_ref}/

Request

  • The document declares no server URL.
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

agent_idstring uuid required

External ID of this agent, used on the simple agent thread API

thread_refstring required

External reference ID of the thread

Query parameters

account_idinteger

Execution account ID. Required for installable agents.

Response

idinteger required
titlestring required
visibility'private' | 'account_read' | 'account_write' required
  • private - Private
  • account_read - Account read
  • account_write - Account write
externalReferenceIdstring required
accountinteger required
agentstring uuid required

External ID of this agent, used on the simple agent thread API

currentAgentstring uuid required

External ID of this agent, used on the simple agent thread API

userinteger required
executionStatus'idle' | 'running' | 'completed' | 'failed'
  • idle - Idle
  • running - Running
  • completed - Completed
  • failed - Failed
contentTypestring nullable

Lowercased Django model name of the linked object (e.g. 'layout', 'tracking'). Pair with object_id.

objectIdstring
createdAtstring date-time required
updatedAtstring date-time required
progressTextstring required
progressReasoningstring required

Changes