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>"
}
'
import requests

url = "https://api.example.com/agents/instances/{instance_id}"

payload = {
    "task_id": "<string>",
    "turn_count": 123,
    "tokens_total": 123,
    "needs_input": True,
    "current_step": "<string>",
    "last_action_at": "<string>",
    "session_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    task_id: '<string>',
    turn_count: 123,
    tokens_total: 123,
    needs_input: true,
    current_step: '<string>',
    last_action_at: '<string>',
    session_id: '<string>'
  })
};

fetch('https://api.example.com/agents/instances/{instance_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/agents/instances/{instance_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'task_id' => '<string>',
    'turn_count' => 123,
    'tokens_total' => 123,
    'needs_input' => true,
    'current_step' => '<string>',
    'last_action_at' => '<string>',
    'session_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/agents/instances/{instance_id}"

	payload := strings.NewReader("{\n  \"task_id\": \"<string>\",\n  \"turn_count\": 123,\n  \"tokens_total\": 123,\n  \"needs_input\": true,\n  \"current_step\": \"<string>\",\n  \"last_action_at\": \"<string>\",\n  \"session_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.example.com/agents/instances/{instance_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"task_id\": \"<string>\",\n  \"turn_count\": 123,\n  \"tokens_total\": 123,\n  \"needs_input\": true,\n  \"current_step\": \"<string>\",\n  \"last_action_at\": \"<string>\",\n  \"session_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/instances/{instance_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task_id\": \"<string>\",\n  \"turn_count\": 123,\n  \"tokens_total\": 123,\n  \"needs_input\": true,\n  \"current_step\": \"<string>\",\n  \"last_action_at\": \"<string>\",\n  \"session_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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.

Agent instances live inside the tenant SurrealDB namespace — the namespace is the organization boundary, so the record itself carries no organization_id field.

Attributes: id: SurrealDB record ID (populated by database). 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.

​
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