Annotation
Tagged provider annotation attached to generated content, such as a citation or PDF reference.
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 |
|---|---|---|---|
urlCitation | UrlCitation | Optional | Submessage fields (optional); populate the one matching kind |
pdf | PdfAnnotation | Optional | PDF annotation or parser configuration selected by the enclosing message. |
kind | string (ANNOTATION_KIND_URL_CITATION, ANNOTATION_KIND_PDF) or integer (int32) | Optional | Selected kind; determines which submessage is populated |
metadata | Map from string to string | Optional | Provider-specific extras. |
Values of kind
Kind of source annotation associated with generated content.
| Value | No. | Form | Meaning |
|---|---|---|---|
ANNOTATION_KIND_URL_CITATION | 1 | Canonical | A citation to a source identified by its URL. |
ANNOTATION_KIND_PDF | 2 | Canonical | An annotation identifying source content in a PDF document. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
urlCitation | UrlCitation | Optional | Submessage fields (optional); populate the one matching kind |
pdf | PdfAnnotation | Optional | PDF annotation or parser configuration selected by the enclosing message. |
kind | string (ANNOTATION_KIND_URL_CITATION, ANNOTATION_KIND_PDF) or integer (int32) | Optional | Selected kind; determines which submessage is populated |
metadata | Map from string to string | Optional | Provider-specific extras. |
Values of kind
Kind of source annotation associated with generated content.
| Value | No. | Form | Meaning |
|---|---|---|---|
ANNOTATION_KIND_URL_CITATION | 1 | Canonical | A citation to a source identified by its URL. |
ANNOTATION_KIND_PDF | 2 | Canonical | An annotation identifying source content in a PDF document. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
url_citation | UrlCitation | Optional | Submessage fields (optional); populate the one matching kind |
pdf | PdfAnnotation | Optional | PDF annotation or parser configuration selected by the enclosing message. |
kind | string (ANNOTATION_KIND_URL_CITATION, ANNOTATION_KIND_PDF) or integer (int32) | Optional | Selected kind; determines which submessage is populated |
metadata | Map from string to string | Optional | Provider-specific extras. |
Values of kind
Kind of source annotation associated with generated content.
| Value | No. | Form | Meaning |
|---|---|---|---|
ANNOTATION_KIND_URL_CITATION | 1 | Canonical | A citation to a source identified by its URL. |
ANNOTATION_KIND_PDF | 2 | Canonical | An annotation identifying source content in a PDF document. |
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). |
| Message | Nested in model |
| Message | Nested in model |
| Message | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-annotation.