Section ID:
DOC-API-MODEL-schema-qj0o2cvv4e#overview
ClientToolDispatch
A batch of client-tool calls awaiting execution for a conversation turn.
Type-reference view: API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#request-field-toolcallstoolCalls | Array of ToolCall | Optional | Tool calls emitted by the model or returned by the operation. |
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#request-field-dispatchseqdispatchSeq | string (int64) | Optional | Client-tool dispatch sequence used to wait for a later dispatch batch. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#request-field-assistantmessageassistantMessage | Message | Optional | Assistant message that armed this batch. The finish reason can be the same for a client-tool turn and an MCP turn; use the run status to distinguish them. |
In responses
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#field-toolcallsSection ID: DOC-API-MODEL-schema-qj0o2cvv4e#response-field-toolcallstoolCalls | Array of ToolCall | Optional | Tool calls emitted by the model or returned by the operation. |
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#field-dispatchseqSection ID: DOC-API-MODEL-schema-qj0o2cvv4e#response-field-dispatchseqdispatchSeq | string (int64) | Optional | Client-tool dispatch sequence used to wait for a later dispatch batch. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#field-assistantmessageSection ID: DOC-API-MODEL-schema-qj0o2cvv4e#response-field-assistantmessageassistantMessage | Message | Optional | Assistant message that armed this batch. The finish reason can be the same for a client-tool turn and an MCP turn; use the run status to distinguish them. |
Where used
Section ID: DOC-API-MODEL-schema-qj0o2cvv4e#where-used
| Reference | Relationship |
|---|---|
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-qj0o2cvv4e