Skip to main content
PATCH
/
agents
/
instances
/
{instance_id}
Update Instance
curl --request PATCH \
  --url https://api.example.com/agents/instances/{instance_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "turn_count": 123,
  "tokens_total": 123,
  "needs_input": true,
  "current_step": "<string>",
  "last_action_at": "<string>",
  "session_id": "<string>"
}
'
{
  "organization_id": "<string>",
  "agent_type_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "task_id": "<string>",
  "status": "starting",
  "started_at": "<string>",
  "ended_at": "<string>",
  "turn_count": 0,
  "tokens_total": 0,
  "needs_input": false,
  "current_step": "<string>",
  "last_action_at": "<string>",
  "session_id": "<string>"
}

Path Parameters

​
instance_id
string
required

Body

application/json

Request body for updating an agent instance. All fields optional.

Status changes are not allowed here — use the transition endpoint instead.

Attributes: task_id: Task this instance is working on. turn_count: Number of LLM turns completed. tokens_total: Total tokens consumed. needs_input: Whether the instance is blocked waiting for human input. current_step: Description of what the instance is currently doing. last_action_at: Timestamp of the most recent action. session_id: External session identifier.

​
task_id
string | null
​
turn_count
integer | null
​
tokens_total
integer | null
​
needs_input
boolean | null
​
current_step
string | null
​
last_action_at
string | null
​
session_id
string | null

Response

Successful Response

A running or completed agent session.

Attributes: id: SurrealDB record ID (populated by database). organization_id: Owning organization. agent_type_id: Agent type this instance runs. task_id: Task this instance is working on. status: Current lifecycle status. started_at: When the instance began execution. ended_at: When the instance reached a terminal status. turn_count: Number of LLM turns completed. tokens_total: Total tokens consumed. needs_input: Whether the instance is blocked waiting for human input. current_step: Description of what the instance is currently doing. last_action_at: Timestamp of the most recent action. session_id: External session identifier for conversation continuity.

​
organization_id
string
required
​
agent_type_id
string
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string | null
​
task_id
string | null
​
status
enum<string>
default:starting

Lifecycle status of an agent instance.

Available options:
starting,
running,
waiting,
paused,
completed,
error,
stopped
​
started_at
string | null
​
ended_at
string | null
​
turn_count
integer
default:0
​
tokens_total
integer
default:0
​
needs_input
boolean
default:false
​
current_step
string | null
​
last_action_at
string | null
​
session_id
string | null