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.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
toolCallId | string | Optional | Required call identifier, copied from the pending ToolCall.id. |
toolName | string | Optional | Required tool name, copied from the pending ToolCall.name. |
resultJson | 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. |
error | 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
| 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: DOC-API-MODEL-client-tool-result.