DOC-API-MODEL-schema-1i4kndhs46#overview
ClientToolResult
Result submitted by the caller for a client-side tool call. Both tool_call_id and tool_name must identify the same pending call. When submission reaches workflow validation, either missing value causes a 400 response. Copy the call's id and name into these result fields, rather than submitting the pending ToolCall unchanged.
Fields marked optional in the wire shape may still be required for a valid workflow submission. Both tool_call_id and tool_name must identify the same pending call; workflow validation rejects either missing value.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1i4kndhs46#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1i4kndhs46#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1i4kndhs46#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i4kndhs46#field-toolcallidSection ID: DOC-API-MODEL-schema-1i4kndhs46#request-field-toolcallidtoolCallId | string | Optional | Required call identifier, copied from the pending ToolCall.id. |
Section ID: DOC-API-MODEL-schema-1i4kndhs46#field-toolnameSection ID: DOC-API-MODEL-schema-1i4kndhs46#request-field-toolnametoolName | string | Optional | Required tool name, copied from the pending ToolCall.name. |
Section ID: DOC-API-MODEL-schema-1i4kndhs46#field-resultjsonSection ID: DOC-API-MODEL-schema-1i4kndhs46#request-field-resultjsonresultJson | Map from string to JSON value | Optional | Structured output for a matched pending call. A nonempty object records COMPLETED; an empty or omitted object records FAILED, including when the client could not complete the action. |
Section ID: DOC-API-MODEL-schema-1i4kndhs46#field-errorSection ID: DOC-API-MODEL-schema-1i4kndhs46#request-field-errorerror | RpcError | Optional | Supplied error detail. The current result handler does not consume this field; the presence of a nonempty result_json alone determines whether the tool is recorded as completed. |
Where used
Section ID: DOC-API-MODEL-schema-1i4kndhs46#where-used
| Reference | Relationship |
|---|---|
| Submit client-side tool execution results | POST /api/v1/llm/submit-client-tool-results |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1i4kndhs46