Skip to main content
DELETE
/
api
/
v1
/
agent-sessions
/
{id}
Delete Agent Session
curl --request DELETE \
  --url http://localhost:3301/api/v1/agent-sessions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running",
  "state": {},
  "metadata": {},
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Path Parameters

​
id
string
required

AgentSession ID

Response

An agent execution session

An agent execution session

​
id
string<uuid>

Unique identifier

​
agent_id
string<uuid>

Parent agent ID

​
workspace_id
string<uuid>

Workspace ID

​
status
enum<string>

Session status

Available options:
running,
waiting_for_input,
completed,
failed
​
state
object

Session state data

​
metadata
object

Session metadata

​
error_message
string | null

Error message if session failed

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp