VocalDocscontracts 1.65.0

Update a Tool binding

PATCH /v1/tool-bindings/{tool_binding_id}

PropertyValue
Operationupdate_tool_binding
GroupTool bindings
Scopeintegrations:write
Route classcontrol
IdempotencyNo Idempotency-Key
AuditAudited integrations.tool_binding.update (mutation)
Released in1.60.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Replaces the bound tools at the revision If-Match names, checked as a create is (1.60.0). A tool still bound keeps its tool_id. Published Agent versions keep the copy they froze; the change reaches Calls through the next publish.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/tool-bindings/tbd_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{
    "tools": [
      {
        "tool": "<tool>"
      }
    ]
  }'

Parameters

NameInTypeRequiredDescription
tool_binding_idpathToolBindingIdyesThe id of a Tool binding: tbd_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
if-matchheaderstringyesThe revision the change was made against, quoted as the ETag returns it, or * to overwrite.

Request body

Content type application/json, required: ToolBindingUpdateRequest.

FieldTypeRequiredDescription
toolsarray of ToolBindingToolInputyes

Responses

StatusContent typeShapeError codes
200application/jsonToolBinding
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden, org_suspended
404application/jsonErrorEnvelopenot_found
409application/jsonErrorEnvelopeconnection_revoked
412application/jsonErrorEnveloperevision_mismatch
422application/jsonErrorEnvelopevalidation_failed, capability_not_available
428application/jsonErrorEnvelopeprecondition_required
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is ToolBinding.

FieldTypeRequiredDescription
agent_idAgentIdyes
binding_sha256Sha256HexyesThe digest of the canonical binding (toolBindingSha256Source), which a frozen copy and a grant name.
connection_idConnectionIdyes
connector_idConnectorId or nullyes
connector_versionstring or nullyesThe manifest version the tools were pinned from; null for an MCP server.
created_atTimestampyes
idToolBindingIdyes
mcp_server_idMcpServerId or nullyes
object"tool_binding"yes
organization_idOrganizationIdyes
originConnectionOriginyes
revisionintegeryes
toolsarray of ToolBindingToolyes
updated_atTimestampyes