Section ID:
DOC-API-MODEL-schema-1hsi58i6pb#overview
PdfAnnotation
Provider annotation identifying a parsed PDF and reusable parsing output.
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-1hsi58i6pb#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request-field-filenamefilename | string | Optional | Optional identifying information about the original file |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request-field-engineengine | string | Optional | PDF parsing engine used by provider (e.g., "pdf-text", "mistral-ocr", "native") |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request-field-tokentoken | string | Optional | Opaque provider token or handle allowing reuse without re-parsing |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request-field-sourceurlsourceUrl | string | Optional | Optional: original source reference (public URL or data: URL) |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request-field-hashhash | string | Optional | Provider-supplied hash identifying the parsed file. |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#request-field-contentcontent | Array of ContentPart | Optional | Optional structured content returned by provider annotations (text, image URLs, etc.) Note: This can be large; include only if you need to round-trip provider annotations. |
In responses
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#field-filenameSection ID: DOC-API-MODEL-schema-1hsi58i6pb#response-field-filenamefilename | string | Optional | Optional identifying information about the original file |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#field-engineSection ID: DOC-API-MODEL-schema-1hsi58i6pb#response-field-engineengine | string | Optional | PDF parsing engine used by provider (e.g., "pdf-text", "mistral-ocr", "native") |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#field-tokenSection ID: DOC-API-MODEL-schema-1hsi58i6pb#response-field-tokentoken | string | Optional | Opaque provider token or handle allowing reuse without re-parsing |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#field-sourceurlSection ID: DOC-API-MODEL-schema-1hsi58i6pb#response-field-sourceurlsourceUrl | string | Optional | Optional: original source reference (public URL or data: URL) |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#field-hashSection ID: DOC-API-MODEL-schema-1hsi58i6pb#response-field-hashhash | string | Optional | Provider-supplied hash identifying the parsed file. |
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#field-contentSection ID: DOC-API-MODEL-schema-1hsi58i6pb#response-field-contentcontent | Array of ContentPart | Optional | Optional structured content returned by provider annotations (text, image URLs, etc.) Note: This can be large; include only if you need to round-trip provider annotations. |
Where used
Section ID: DOC-API-MODEL-schema-1hsi58i6pb#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-1hsi58i6pb