UrlCitation
=== Annotations === Web source and character range cited in generated message content.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
url | string | Optional | URL associated with the resource or outbound request. |
title | string | Optional | Title of the web page cited by this annotation. |
content | string | Optional | Excerpt or snippet of the cited web page. |
startIndex | integer (int32) | Optional | Character index in message content. Minimum: -2147483648. Maximum: 2147483647. |
endIndex | integer (int32) | Optional | Character index in message content. Minimum: -2147483648. Maximum: 2147483647. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
url | string | Optional | URL associated with the resource or outbound request. |
title | string | Optional | Title of the web page cited by this annotation. |
content | string | Optional | Excerpt or snippet of the cited web page. |
startIndex | integer (int32) | Optional | Character index in message content. Minimum: -2147483648. Maximum: 2147483647. |
endIndex | integer (int32) | Optional | Character index in message content. Minimum: -2147483648. Maximum: 2147483647. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
url | string | Optional | URL associated with the resource or outbound request. |
title | string | Optional | Title of the web page cited by this annotation. |
content | string | Optional | Excerpt or snippet of the cited web page. |
start_index | integer (int32) | Optional | Character index in message content. Minimum: -2147483648. Maximum: 2147483647. |
end_index | integer (int32) | Optional | Character index in message content. Minimum: -2147483648. Maximum: 2147483647. |
Where used
| Reference | Relationship |
|---|---|
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| 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 |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| Annotation | Nested in model |
| Annotation | Nested in model |
| Annotation | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-url-citation.