Operations
Operations

Set tool params

Replace an HTTP tool's input parameter schema. Identify the tool by toolName (its snake_case name) or toolId. `properties` is a map of name → `{ type, description }`. `required` is the list of names the LLM MUST provide. Names may use only letters, digits, `_`, `.` and `-`, up to 64 characters, or the write is refused. The runtime injects these into the request body (POST) or query string (GET). Optionally pass `input_examples`, worked example calls the runtime forwards to the model as its `input_examples` field, for any tool whose arguments are nested, optional, or format-sensitive. This REPLACES the whole schema, so re-send `input_examples` when editing `properties` or they are dropped.

POST
/operations/set_tool_params

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/operations/set_tool_params" \  -H "Content-Type: application/json" \  -d '{    "params": {      "properties": {        "property1": {          "type": "string"        },        "property2": {          "type": "string"        }      },      "required": [        "string"      ]    },    "agent": "string"  }'
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}

Set tool outputs POST

Keep fields of an in-call HTTP tool's response as variables for after the call. `outputs` maps a snake_case variable name to a dot path in the JSON response, the same grammar as a workflow function's outputs: {"booking_id": "booking.id", "first_slot": "slots[0].start"}. After each successful response the runtime reads each path and keeps the value for the rest of the call; a repeat call keeps the latest value, and a missing path or a non-JSON body keeps nothing and never changes what the agent hears. Hang-up and post-call functions then read the value as {{booking_id}}. A name must not be a system or post-call variable, a caller detail, a post-call field or a pre-call function output. Replaces the whole map; pass {} to keep none. Nothing is kept when the agent stores basic details only.

Set tool repeat-safe POST

Mark whether a tool re-executes on an identical repeat (`repeatSafe: true`) or is deduplicated (`false`, the default). The runtime keeps a short-lived cache of each completed tool call: a second call with the SAME name + arguments within ~30s normally replays the cached result instead of re-running, a guard that stops a failover turn-rerun from DUPLICATING an external write (a second email / CRM row / booking). Set `repeatSafe: true` ONLY when re-execution has no such side effect AND identical repeats are intended, an idempotent lookup a caller fires repeatedly, or a live-screen reflex action (saying 'up' twice must move the paddle up twice). Leave it `false` for anything that writes. Builtins like `move_paddle` force it on in code; this is the operator override for HTTP tools. Identify the tool by toolName (its snake_case name) or toolId.