Skip to main content
GET
/
v1
/
agents
/
{agent_id}
cURL
curl \
  "https://app.us.goclicks.ai/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/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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transcript": [
    {
      "text": "<string>"
    }
  ]
}
{
  "detail": "<string>"
}
{
  "detail": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}
{
  "detail": "<string>"
}
{
  "detail": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key (ak_...) as a Bearer token. Preferred.

Path Parameters

​
agent_id
string<uuid>
required

Response

Successful Response

​
agent_id
string<uuid>
required
​
loop_status
enum<string>
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.

Available options:
running,
finished,
technical_error,
terminated
​
transcript
TranscriptMessage · object[]
required

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.