DOC-API-MODEL-schema-1ho1lk4ndj#overview
StructuredMessage
A structured message whose JSON payload has been validated against a declared schema. Consumers can trust that json_payload conforms to the schema identified by schema_name.
Inspect the run outcome before treating any message as complete. Current structured metadata is attached to a text content part through structuredMessage; ordinary text is still present. structuredMessage can be absent. Use an object at the schema root and validate the exact final response your application consumes; server validation covers only the first model choice. For integers that your JSON client cannot represent exactly, define string-valued fields in your schema instead of converting them through floating point.
Type-reference view: API Schema 9frhv4euve, 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-1ho1lk4ndj#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#request-field-jsonpayloadjsonPayload | Map from string to JSON value | Optional | The validated JSON payload as a Struct (preserves types) |
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#request-field-schemanameschemaName | string | Optional | Schema identifier (from ResponseFormat.schema_name) |
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#request-field-healedhealed | boolean | Optional | Whether response healing is reported for this structured message. Currently returned as false. |
In responses
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#field-jsonpayloadSection ID: DOC-API-MODEL-schema-1ho1lk4ndj#response-field-jsonpayloadjsonPayload | Map from string to JSON value | Optional | The validated JSON payload as a Struct (preserves types) |
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#field-schemanameSection ID: DOC-API-MODEL-schema-1ho1lk4ndj#response-field-schemanameschemaName | string | Optional | Schema identifier (from ResponseFormat.schema_name) |
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#field-healedSection ID: DOC-API-MODEL-schema-1ho1lk4ndj#response-field-healedhealed | boolean | Optional | Whether response healing is reported for this structured message. Currently returned as false. |
Where used
Section ID: DOC-API-MODEL-schema-1ho1lk4ndj#where-used
| Reference | Relationship |
|---|---|
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| List MCP resources | POST /api/v1/llm/mcp-list-resources |
| Read an MCP resource | POST /api/v1/llm/mcp-read-resource |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| ContentPart | Nested in model |
| ContentPart | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1ho1lk4ndj