Execute a tool by name with parameters.

Tool execution result

POST /v1/tenants/{tenant_id}/agent/execute

cURL

curl --request POST \
  --url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/agent/execute' \
  --header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "confirm": true,
  "params": {},
  "reason": "Two-person tent, green — replacement for damaged pole set.",
  "sessionId": "string",
  "tool": "string"
}'

200

{
  "tool": "string",
  "result": {},
  "sessionId": "string"
}

Path parameters

tenant_id · string · required

Tenant identifier

Request body

ExecuteToolRequest

confirm · boolean

params · object · required

reason · string

sessionId · string

tool · string · required

Response

object

tool · string · required

Name of the tool that was executed

result · object · required

Tool-specific result payload

sessionId · string

Agent session id when one was supplied; null otherwise

Status codes

Code	Meaning
200	Tool execution result
401	Unauthorized
404	Tool not found
428	Confirmation required for mutating tools

cURL

curl --request POST \
  --url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/agent/execute' \
  --header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "confirm": true,
  "params": {},
  "reason": "Two-person tent, green — replacement for damaged pole set.",
  "sessionId": "string",
  "tool": "string"
}'

200

{
  "tool": "string",
  "result": {},
  "sessionId": "string"
}