Sign in
Agent Runs

Get agent run

Changed on
get/api/agent-runs/{runId}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

runIdstring required

Response

Response for status 200

idstring required
projectIdstring required
threadIdstring required
triggerMessageIdstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
modelIdstring
finishReason'stop' | 'length' | 'content-filter' | 'tool-calls' | 'timeout' | 'interrupted' | 'error' | 'other' | 'unknown'
attemptnumber required
streamIdstring required
createdAtstring required
startedAtstring
completedAtstring

Changes

  • 784768a1de35Revision changes
    • warning

      added the new run enum value to the // response property for the response status

    • warning

      added the new step_limit_reached enum value to the // response property for the response status

  • 2e14e083f140Revision changes
    • info

      removed the run enum value from the // response property for the response status

    • info

      removed the step_limit_reached enum value from the // response property for the response status