Section ID:
DOC-API-MODEL-schema-1hujls61ng#overview
UrlCitation
Web source and character range cited in generated message content.
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-1hujls61ng#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1hujls61ng#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1hujls61ng#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1hujls61ng#request-field-urlurl | string | Optional | URL of the cited web page. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#request-field-titletitle | string | Optional | Title of the web page cited by this annotation. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#request-field-contentcontent | string | Optional | Optional excerpt or snippet of the cited web page. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#request-field-startindexstartIndex | string (int64) | Optional | Character index in message content. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#request-field-endindexendIndex | string (int64) | Optional | Character index in message content. Pattern: ^-?\d+$. |
In responses
Section ID: DOC-API-MODEL-schema-1hujls61ng#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1hujls61ng#field-urlSection ID: DOC-API-MODEL-schema-1hujls61ng#response-field-urlurl | string | Optional | URL of the cited web page. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#field-titleSection ID: DOC-API-MODEL-schema-1hujls61ng#response-field-titletitle | string | Optional | Title of the web page cited by this annotation. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#field-contentSection ID: DOC-API-MODEL-schema-1hujls61ng#response-field-contentcontent | string | Optional | Optional excerpt or snippet of the cited web page. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#field-startindexSection ID: DOC-API-MODEL-schema-1hujls61ng#response-field-startindexstartIndex | string (int64) | Optional | Character index in message content. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1hujls61ng#field-endindexSection ID: DOC-API-MODEL-schema-1hujls61ng#response-field-endindexendIndex | string (int64) | Optional | Character index in message content. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1hujls61ng#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 |
| 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 |
|---|---|
| Annotation | Nested in model |
| Annotation | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1hujls61ng