Skip to content
Subako Docs
Esc
navigateopen⌘Jpreview

PUT /v1/sessions/{session_id}/clients/{client_id}/tools

PUT/v1/sessions/{session_id}/clients/{client_id}/tools
Authorization
AuthorizationBearer token · headerrequired
Path parameters
session_idstring<uuid>required
Session id
client_idstring<uuid>required
Client id
Request body
requiredapplication/json
toolsClientToolBody[]required
max items 64
Show properties
Array of ClientToolBody
descriptionstringrequired
What the tool does, as the model reads it.
max length 4096
namestringrequired
min length 1 · max length 64 · matches ^[A-Za-z0-9_-]+$
parametersobjectrequired
JSON Schema object describing the tool's arguments.
Responses
200Replaced, and recorded in the log. A live run reads the new list before its next model call, and a tool dropped here is refused from this moment: a call naming it comes back to the model as an error listing what the client does offer. A tool call that changes the page (a navigation) should replace the list here before answering the call, so the model reads the answer and the new tools together.
seqinteger<int64>required
400Malformed body or path parameter, or a tool outside its charset, length, or count.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
401Missing, malformed, or invalid credential.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
403A workspace credential lacking session.manage.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
404No such live client on this session.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PUT "https://api.us.cloud.subako.ai/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/tools" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "tools": [
    {
      "description": "string",
      "name": "string",
      "parameters": {}
    }
  ]
}'
Response
{
  "agent_id": "string",
  "agent_version_id": "string",
  "type": "session_created",
  "seq": 0
}