DELETE
/
agents
/
{agent_id}
/
stop
{
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_id": "<string>",
  "status": "active",
  "closed_at": "2023-11-07T05:31:56Z",
  "saved": false,
  "credit_usage": 123,
  "task": "<string>",
  "url": "<string>",
  "success": true,
  "answer": "<string>",
  "steps": [
    {
      "state": {},
      "action": {}
    }
  ],
  "replay_start_offset": 123,
  "replay_stop_offset": 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

Query Parameters

​
session_id
string | null
required

Response

Successful Response

​
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_start_offset
integer
required

The start offset of the replay

​
replay_stop_offset
integer
required

The stop offset of the replay

​
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

​
credit_usage
number | null

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

​
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
AgentCompletion · object[]

The steps that the agent has currently taken