PdfAnnotation

Provider annotation identifying a parsed PDF and reusable parsing output.

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
filename	string	Optional	Optional identifying information about the original file
engine	string	Optional	PDF parsing engine used by provider (e.g., "pdf-text", "mistral-ocr", "native")
token	string	Optional	Opaque provider token or handle allowing reuse without re-parsing
sourceUrl	string	Optional	Optional: original source reference (public URL or data: URL)
hash	string	Optional	Provider-supplied hash identifying the parsed file.
content	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

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
filename	string	Optional	Optional identifying information about the original file
engine	string	Optional	PDF parsing engine used by provider (e.g., "pdf-text", "mistral-ocr", "native")
token	string	Optional	Opaque provider token or handle allowing reuse without re-parsing
sourceUrl	string	Optional	Optional: original source reference (public URL or data: URL)
hash	string	Optional	Provider-supplied hash identifying the parsed file.
content	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 webhook payloads

Webhook JSON uses protobuf field names (snake_case).

Field	Type	Presence	Meaning
filename	string	Optional	Optional identifying information about the original file
engine	string	Optional	PDF parsing engine used by provider (e.g., "pdf-text", "mistral-ocr", "native")
token	string	Optional	Opaque provider token or handle allowing reuse without re-parsing
source_url	string	Optional	Optional: original source reference (public URL or data: URL)
hash	string	Optional	Provider-supplied hash identifying the parsed file.
content	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

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.

• conversations OpenAPI

Document: DOC-API-MODEL-pdf-annotation.