Sign in

v1

latestOpenAPI 3.1.02026-07-223811.6 KB
public-api

Get an agent run

Return an agent run's status and transcript.

Poll every 3 to 10 seconds while loop_status is running. Runs commonly take several minutes. For the status values, see the Agent lifecycle and polling guide.

The response is scoped to the API key: a run that belongs to another organization or agent returns 404, so a key can't enumerate or inspect runs it doesn't own.

get/v1/agents/{agent_id}

Path parameters

agent_idstring uuid required

Response

Successful Response

agent_idstring uuid required
loop_status'running' | 'finished' | 'technical_error' | 'terminated' required

running: the agent is working, which includes startup. finished: the agent is idle; when it ended its turn normally, the output for the last input is complete. technical_error: the run hit an internal error. terminated: the run was stopped or deleted.

Example response

{
  "agent_id": "0f4d3f9a-6b1c-4a2e-8c7d-5e9b0a1f2c3d",
  "loop_status": "finished",
  "transcript": [
    {
      "role": "input_to_agent",
      "text": "Summarize report.pdf in three bullet points."
    },
    {
      "role": "output_from_agent",
      "text": "1. Revenue grew 12% ..."
    }
  ]
}