curl \
"https://app.us.goclicks.ai/api/orchestrator/v1/agents/$AGENT_ID" \
-H "Authorization: Bearer $CLICKS_API_KEY"import os, requests
agent_id = "<run-id>"
resp = requests.get(
f"https://app.us.goclicks.ai/api/orchestrator/v1/agents/{agent_id}",
headers={"Authorization": f"Bearer {os.environ['CLICKS_API_KEY']}"},
)
resp.raise_for_status()
run = resp.json()
print(run["loop_status"], run["transcript"]){
"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% ..."
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}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.
curl \
"https://app.us.goclicks.ai/api/orchestrator/v1/agents/$AGENT_ID" \
-H "Authorization: Bearer $CLICKS_API_KEY"import os, requests
agent_id = "<run-id>"
resp = requests.get(
f"https://app.us.goclicks.ai/api/orchestrator/v1/agents/{agent_id}",
headers={"Authorization": f"Bearer {os.environ['CLICKS_API_KEY']}"},
)
resp.raise_for_status()
run = resp.json()
print(run["loop_status"], run["transcript"]){
"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% ..."
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
API key (ak_...) as a Bearer token. Preferred.
Path Parameters
Response
Successful Response
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.
running, finished, technical_error, terminated The inputs the agent accepted and each turn's final output, ordered oldest first. It doesn't include intermediate tool steps. An empty transcript early in a run is normal.
Show child attributes
Show child attributes