GET
/
agents
/
{agent_id}
{
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_id": "<string>",
  "status": "active",
  "closed_at": "2023-11-07T05:31:56Z",
  "saved": false,
  "task": "<string>",
  "url": "<string>",
  "success": true,
  "answer": "<string>",
  "steps": [
    {}
  ],
  "credit_usage": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
agent_id
string
required

Response

200
application/json

Successful Response

This class is used to handle the legacy agent status response. The rationale is that we are likely to change the AgentStepResponse in the future and we want to be able to handle the legacy response. This is a temporary solution to avoid breaking changes.

​
agent_id
string
required

The ID of the agent

​
created_at
string<date-time>
required

The creation time of the agent

​
session_id
string
required

The ID of the session

​
status
enum<string>
required

The status of the agent (active or closed)

Available options:
active,
closed
​
task
string
required

The task that the agent is currently running

​
replay
file | null

The session replay in .webp format

​
closed_at
string<date-time> | null

The closing time of the agent

​
saved
boolean
default:false

Whether the agent is saved as a workflow

​
url
string | null

The URL that the agent started on

​
success
boolean | null

Whether the agent task was successful. None if the agent is still running

​
answer
string | null

The answer to the agent task. None if the agent is still running

​
steps
Steps · object[]
​
credit_usage
number | null

Credit usage for the agent. None if the agent is still running