Skip to main content
Section ID: DOC-API-MODEL-schema-1j7jbpfsda#overview

ToolApproval

Approval decision for a specific tool call

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1j7jbpfsda#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1j7jbpfsda#fields

UsageFields and validation
In requestsView fields

In requests​

Section ID: DOC-API-MODEL-schema-1j7jbpfsda#request

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1j7jbpfsda#field-toolcallidSection ID: DOC-API-MODEL-schema-1j7jbpfsda#request-field-toolcallidtoolCallIdstringOptionalIdentifier of the tool call whose execution is being approved or rejected.
Section ID: DOC-API-MODEL-schema-1j7jbpfsda#field-toolnameSection ID: DOC-API-MODEL-schema-1j7jbpfsda#request-field-toolnametoolNamestringOptionalName of the tool associated with the call or result.
Section ID: DOC-API-MODEL-schema-1j7jbpfsda#field-approvedSection ID: DOC-API-MODEL-schema-1j7jbpfsda#request-field-approvedapprovedbooleanOptionalWhether the caller approves execution of the identified tool call.
Section ID: DOC-API-MODEL-schema-1j7jbpfsda#field-reasonSection ID: DOC-API-MODEL-schema-1j7jbpfsda#request-field-reasonreasonstringOptionalOptional rejection reason.

Where used​

Section ID: DOC-API-MODEL-schema-1j7jbpfsda#where-used

ReferenceRelationship
Approve or reject pending tool callsPOST /api/v1/llm/submit-tool-approvals

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1j7jbpfsda