Parse Configurations
Create Parse Configuration
List Parse Configurations
Get Parse Configuration
Update Parse Configuration
Delete Parse Configuration
ModelsExpand Collapse
class ParseConfiguration: …
Parse configuration schema.
id: str
Unique identifier for the parse configuration
created_at: datetime
Creation timestamp
name: str
Name of the parse configuration
LlamaParseParameters configuration
images_to_save: Optional[List[Literal["screenshot", "embedded", "layout"]]]
parse_mode: Optional[ParsingMode]
Enum for representing the mode of parsing to be used.
priority: Optional[Literal["low", "medium", "high", "critical"]]
The priority for the request. This field may be ignored or overwritten depending on the organization tier.
replace_failed_page_mode: Optional[FailPageMode]
Enum for representing the different available page error handling modes.
webhook_configurations: Optional[List[WebhookConfiguration]]
Outbound webhook endpoints to notify on job status changes
webhook_events: Optional[List[Literal["extract.pending", "extract.success", "extract.error", 14 more]]]
Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered.
webhook_headers: Optional[Dict[str, str]]
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
webhook_output_format: Optional[str]
Response format sent to the webhook: 'string' (default) or 'json'
webhook_url: Optional[str]
URL to receive webhook POST notifications
source_id: str
ID of the source
source_type: str
Type of the source (e.g., 'project')
updated_at: datetime
Last update timestamp
version: str
Version of the configuration
creator: Optional[str]
Creator of the configuration
class ParseConfigurationCreate: …
Schema for creating a new parse configuration (API boundary).
name: str
Name of the parse configuration
LlamaParseParameters configuration
images_to_save: Optional[List[Literal["screenshot", "embedded", "layout"]]]
parse_mode: Optional[ParsingMode]
Enum for representing the mode of parsing to be used.
priority: Optional[Literal["low", "medium", "high", "critical"]]
The priority for the request. This field may be ignored or overwritten depending on the organization tier.
replace_failed_page_mode: Optional[FailPageMode]
Enum for representing the different available page error handling modes.
webhook_configurations: Optional[List[WebhookConfiguration]]
Outbound webhook endpoints to notify on job status changes
webhook_events: Optional[List[Literal["extract.pending", "extract.success", "extract.error", 14 more]]]
Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered.
webhook_headers: Optional[Dict[str, str]]
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
webhook_output_format: Optional[str]
Response format sent to the webhook: 'string' (default) or 'json'
webhook_url: Optional[str]
URL to receive webhook POST notifications
version: str
Version of the configuration
creator: Optional[str]
Creator of the configuration
source_id: Optional[str]
ID of the source
source_type: Optional[str]
Type of the source (e.g., 'project')
class ParseConfigurationQueryResponse: …
Response schema for paginated parse configuration queries.
The list of items.
id: str
Unique identifier for the parse configuration
created_at: datetime
Creation timestamp
name: str
Name of the parse configuration
LlamaParseParameters configuration
images_to_save: Optional[List[Literal["screenshot", "embedded", "layout"]]]
parse_mode: Optional[ParsingMode]
Enum for representing the mode of parsing to be used.
priority: Optional[Literal["low", "medium", "high", "critical"]]
The priority for the request. This field may be ignored or overwritten depending on the organization tier.
replace_failed_page_mode: Optional[FailPageMode]
Enum for representing the different available page error handling modes.
webhook_configurations: Optional[List[WebhookConfiguration]]
Outbound webhook endpoints to notify on job status changes
webhook_events: Optional[List[Literal["extract.pending", "extract.success", "extract.error", 14 more]]]
Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered.
webhook_headers: Optional[Dict[str, str]]
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
webhook_output_format: Optional[str]
Response format sent to the webhook: 'string' (default) or 'json'
webhook_url: Optional[str]
URL to receive webhook POST notifications
source_id: str
ID of the source
source_type: str
Type of the source (e.g., 'project')
updated_at: datetime
Last update timestamp
version: str
Version of the configuration
creator: Optional[str]
Creator of the configuration
next_page_token: Optional[str]
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
total_size: Optional[int]
The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.