Skip to content
LlamaIndex API Docs
Get started
API Reference
Beta
Parse Configurations

List Parse Configurations

GET/api/v1/beta/parse-configurations

List parse configurations for the current project.

Args: project: Validated project from dependency user: Current user db: Database session page_size: Number of items per page page_token: Token for pagination name: Filter by configuration name creator: Filter by creator version: Filter by version

Returns: Paginated response with parse configurations

Query ParametersExpand Collapse
creator: optional string
name: optional string
organization_id: optional string
page_size: optional number
page_token: optional string
project_id: optional string
version: optional string
Cookie ParametersExpand Collapse
session: optional string
ReturnsExpand Collapse
ParseConfigurationQueryResponse = object { items, next_page_token, total_size }

Response schema for paginated parse configuration queries.

items: array of ParseConfiguration { id, created_at, name, 6 more }

The list of items.

id: string

Unique identifier for the parse configuration

created_at: string

Creation timestamp

formatdate-time
name: string

Name of the parse configuration

parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }

LlamaParseParameters configuration

adaptive_long_table: optional boolean
aggressive_table_extraction: optional boolean
auto_mode: optional boolean
auto_mode_configuration_json: optional string
auto_mode_trigger_on_image_in_page: optional boolean
auto_mode_trigger_on_regexp_in_page: optional string
auto_mode_trigger_on_table_in_page: optional boolean
auto_mode_trigger_on_text_in_page: optional string
azure_openai_api_version: optional string
azure_openai_deployment_name: optional string
azure_openai_endpoint: optional string
azure_openai_key: optional string
bbox_bottom: optional number
bbox_left: optional number
bbox_right: optional number
bbox_top: optional number
bounding_box: optional string
compact_markdown_table: optional boolean
complemental_formatting_instruction: optional string
content_guideline_instruction: optional string
continuous_mode: optional boolean
disable_image_extraction: optional boolean
disable_ocr: optional boolean
disable_reconstruction: optional boolean
do_not_cache: optional boolean
do_not_unroll_columns: optional boolean
enable_cost_optimizer: optional boolean
extract_charts: optional boolean
extract_layout: optional boolean
extract_printed_page_number: optional boolean
fast_mode: optional boolean
formatting_instruction: optional string
gpt4o_api_key: optional string
gpt4o_mode: optional boolean
guess_xlsx_sheet_name: optional boolean
hide_footers: optional boolean
hide_headers: optional boolean
high_res_ocr: optional boolean
html_make_all_elements_visible: optional boolean
html_remove_fixed_elements: optional boolean
html_remove_navigation_elements: optional boolean
http_proxy: optional string
ignore_document_elements_for_layout_detection: optional boolean
images_to_save: optional array of "screenshot" or "embedded" or "layout"
Accepts one of the following:
"screenshot"
"embedded"
"layout"
inline_images_in_markdown: optional boolean
input_s3_path: optional string
input_s3_region: optional string
input_url: optional string
internal_is_screenshot_job: optional boolean
invalidate_cache: optional boolean
is_formatting_instruction: optional boolean
job_timeout_extra_time_per_page_in_seconds: optional number
job_timeout_in_seconds: optional number
keep_page_separator_when_merging_tables: optional boolean
languages: optional array of ParsingLanguages
Accepts one of the following:
"af"
"az"
"bs"
"cs"
"cy"
"da"
"de"
"en"
"es"
"et"
"fr"
"ga"
"hr"
"hu"
"id"
"is"
"it"
"ku"
"la"
"lt"
"lv"
"mi"
"ms"
"mt"
"nl"
"no"
"oc"
"pi"
"pl"
"pt"
"ro"
"rs_latin"
"sk"
"sl"
"sq"
"sv"
"sw"
"tl"
"tr"
"uz"
"vi"
"ar"
"fa"
"ug"
"ur"
"bn"
"as"
"mni"
"ru"
"rs_cyrillic"
"be"
"bg"
"uk"
"mn"
"abq"
"ady"
"kbd"
"ava"
"dar"
"inh"
"che"
"lbe"
"lez"
"tab"
"tjk"
"hi"
"mr"
"ne"
"bh"
"mai"
"ang"
"bho"
"mah"
"sck"
"new"
"gom"
"sa"
"bgc"
"th"
"ch_sim"
"ch_tra"
"ja"
"ko"
"ta"
"te"
"kn"
layout_aware: optional boolean
line_level_bounding_box: optional boolean
markdown_table_multiline_header_separator: optional string
max_pages: optional number
max_pages_enforced: optional number
merge_tables_across_pages_in_markdown: optional boolean
model: optional string
outlined_table_extraction: optional boolean
output_pdf_of_document: optional boolean
output_s3_path_prefix: optional string
output_s3_region: optional string
output_tables_as_HTML: optional boolean
page_error_tolerance: optional number
page_footer_prefix: optional string
page_footer_suffix: optional string
page_header_prefix: optional string
page_header_suffix: optional string
page_prefix: optional string
page_separator: optional string
page_suffix: optional string
parse_mode: optional ParsingMode

Enum for representing the mode of parsing to be used.

Accepts one of the following:
"parse_page_without_llm"
"parse_page_with_llm"
"parse_page_with_lvm"
"parse_page_with_agent"
"parse_page_with_layout_agent"
"parse_document_with_llm"
"parse_document_with_lvm"
"parse_document_with_agent"
parsing_instruction: optional string
precise_bounding_box: optional boolean
premium_mode: optional boolean
presentation_out_of_bounds_content: optional boolean
presentation_skip_embedded_data: optional boolean
preserve_layout_alignment_across_pages: optional boolean
preserve_very_small_text: optional boolean
preset: optional string
priority: optional "low" or "medium" or "high" or "critical"

The priority for the request. This field may be ignored or overwritten depending on the organization tier.

Accepts one of the following:
"low"
"medium"
"high"
"critical"
project_id: optional string
remove_hidden_text: optional boolean
replace_failed_page_mode: optional FailPageMode

Enum for representing the different available page error handling modes.

Accepts one of the following:
"raw_text"
"blank_page"
"error_message"
replace_failed_page_with_error_message_prefix: optional string
replace_failed_page_with_error_message_suffix: optional string
save_images: optional boolean
skip_diagonal_text: optional boolean
specialized_chart_parsing_agentic: optional boolean
specialized_chart_parsing_efficient: optional boolean
specialized_chart_parsing_plus: optional boolean
specialized_image_parsing: optional boolean
spreadsheet_extract_sub_tables: optional boolean
spreadsheet_force_formula_computation: optional boolean
strict_mode_buggy_font: optional boolean
strict_mode_image_extraction: optional boolean
strict_mode_image_ocr: optional boolean
strict_mode_reconstruction: optional boolean
structured_output: optional boolean
structured_output_json_schema: optional string
structured_output_json_schema_name: optional string
system_prompt: optional string
system_prompt_append: optional string
take_screenshot: optional boolean
target_pages: optional string
tier: optional string
use_vendor_multimodal_model: optional boolean
user_prompt: optional string
vendor_multimodal_api_key: optional string
vendor_multimodal_model_name: optional string
version: optional string
webhook_configurations: optional array of WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url }

The outbound webhook configurations

webhook_events: optional array of "extract.pending" or "extract.success" or "extract.error" or 13 more

List of event names to subscribe to

Accepts one of the following:
"extract.pending"
"extract.success"
"extract.error"
"extract.partial_success"
"extract.cancelled"
"parse.pending"
"parse.success"
"parse.error"
"parse.partial_success"
"parse.cancelled"
"classify.pending"
"classify.success"
"classify.error"
"classify.partial_success"
"classify.cancelled"
"unmapped_event"
webhook_headers: optional map[string]

Custom HTTP headers to include with webhook requests.

webhook_output_format: optional string

The output format to use for the webhook. Defaults to string if none supplied. Currently supported values: string, json

webhook_url: optional string

The URL to send webhook notifications to.

webhook_url: optional string
source_id: string

ID of the source

source_type: string

Type of the source (e.g., 'project')

updated_at: string

Last update timestamp

formatdate-time
version: string

Version of the configuration

creator: optional string

Creator of the configuration

next_page_token: optional string

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 number

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.

List Parse Configurations

curl https://api.cloud.llamaindex.ai/api/v1/beta/parse-configurations \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"
{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "parameters": {
        "adaptive_long_table": true,
        "aggressive_table_extraction": true,
        "annotate_links": true,
        "auto_mode": true,
        "auto_mode_configuration_json": "auto_mode_configuration_json",
        "auto_mode_trigger_on_image_in_page": true,
        "auto_mode_trigger_on_regexp_in_page": "auto_mode_trigger_on_regexp_in_page",
        "auto_mode_trigger_on_table_in_page": true,
        "auto_mode_trigger_on_text_in_page": "auto_mode_trigger_on_text_in_page",
        "azure_openai_api_version": "azure_openai_api_version",
        "azure_openai_deployment_name": "azure_openai_deployment_name",
        "azure_openai_endpoint": "azure_openai_endpoint",
        "azure_openai_key": "azure_openai_key",
        "bbox_bottom": 0,
        "bbox_left": 0,
        "bbox_right": 0,
        "bbox_top": 0,
        "bounding_box": "bounding_box",
        "compact_markdown_table": true,
        "complemental_formatting_instruction": "complemental_formatting_instruction",
        "content_guideline_instruction": "content_guideline_instruction",
        "continuous_mode": true,
        "disable_image_extraction": true,
        "disable_ocr": true,
        "disable_reconstruction": true,
        "do_not_cache": true,
        "do_not_unroll_columns": true,
        "enable_cost_optimizer": true,
        "extract_charts": true,
        "extract_layout": true,
        "extract_printed_page_number": true,
        "fast_mode": true,
        "formatting_instruction": "formatting_instruction",
        "gpt4o_api_key": "gpt4o_api_key",
        "gpt4o_mode": true,
        "guess_xlsx_sheet_name": true,
        "hide_footers": true,
        "hide_headers": true,
        "high_res_ocr": true,
        "html_make_all_elements_visible": true,
        "html_remove_fixed_elements": true,
        "html_remove_navigation_elements": true,
        "http_proxy": "http_proxy",
        "ignore_document_elements_for_layout_detection": true,
        "images_to_save": [
          "screenshot"
        ],
        "inline_images_in_markdown": true,
        "input_s3_path": "input_s3_path",
        "input_s3_region": "input_s3_region",
        "input_url": "input_url",
        "internal_is_screenshot_job": true,
        "invalidate_cache": true,
        "is_formatting_instruction": true,
        "job_timeout_extra_time_per_page_in_seconds": 0,
        "job_timeout_in_seconds": 0,
        "keep_page_separator_when_merging_tables": true,
        "languages": [
          "af"
        ],
        "layout_aware": true,
        "line_level_bounding_box": true,
        "markdown_table_multiline_header_separator": "markdown_table_multiline_header_separator",
        "max_pages": 0,
        "max_pages_enforced": 0,
        "merge_tables_across_pages_in_markdown": true,
        "model": "model",
        "outlined_table_extraction": true,
        "output_pdf_of_document": true,
        "output_s3_path_prefix": "output_s3_path_prefix",
        "output_s3_region": "output_s3_region",
        "output_tables_as_HTML": true,
        "page_error_tolerance": 0,
        "page_footer_prefix": "page_footer_prefix",
        "page_footer_suffix": "page_footer_suffix",
        "page_header_prefix": "page_header_prefix",
        "page_header_suffix": "page_header_suffix",
        "page_prefix": "page_prefix",
        "page_separator": "page_separator",
        "page_suffix": "page_suffix",
        "parse_mode": "parse_page_without_llm",
        "parsing_instruction": "parsing_instruction",
        "precise_bounding_box": true,
        "premium_mode": true,
        "presentation_out_of_bounds_content": true,
        "presentation_skip_embedded_data": true,
        "preserve_layout_alignment_across_pages": true,
        "preserve_very_small_text": true,
        "preset": "preset",
        "priority": "low",
        "project_id": "project_id",
        "remove_hidden_text": true,
        "replace_failed_page_mode": "raw_text",
        "replace_failed_page_with_error_message_prefix": "replace_failed_page_with_error_message_prefix",
        "replace_failed_page_with_error_message_suffix": "replace_failed_page_with_error_message_suffix",
        "save_images": true,
        "skip_diagonal_text": true,
        "specialized_chart_parsing_agentic": true,
        "specialized_chart_parsing_efficient": true,
        "specialized_chart_parsing_plus": true,
        "specialized_image_parsing": true,
        "spreadsheet_extract_sub_tables": true,
        "spreadsheet_force_formula_computation": true,
        "strict_mode_buggy_font": true,
        "strict_mode_image_extraction": true,
        "strict_mode_image_ocr": true,
        "strict_mode_reconstruction": true,
        "structured_output": true,
        "structured_output_json_schema": "structured_output_json_schema",
        "structured_output_json_schema_name": "structured_output_json_schema_name",
        "system_prompt": "system_prompt",
        "system_prompt_append": "system_prompt_append",
        "take_screenshot": true,
        "target_pages": "target_pages",
        "tier": "tier",
        "use_vendor_multimodal_model": true,
        "user_prompt": "user_prompt",
        "vendor_multimodal_api_key": "vendor_multimodal_api_key",
        "vendor_multimodal_model_name": "vendor_multimodal_model_name",
        "version": "version",
        "webhook_configurations": [
          {
            "webhook_events": [
              "extract.pending"
            ],
            "webhook_headers": {
              "foo": "string"
            },
            "webhook_output_format": "webhook_output_format",
            "webhook_url": "webhook_url"
          }
        ],
        "webhook_url": "webhook_url"
      },
      "source_id": "source_id",
      "source_type": "source_type",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "version": "version",
      "creator": "creator"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "parameters": {
        "adaptive_long_table": true,
        "aggressive_table_extraction": true,
        "annotate_links": true,
        "auto_mode": true,
        "auto_mode_configuration_json": "auto_mode_configuration_json",
        "auto_mode_trigger_on_image_in_page": true,
        "auto_mode_trigger_on_regexp_in_page": "auto_mode_trigger_on_regexp_in_page",
        "auto_mode_trigger_on_table_in_page": true,
        "auto_mode_trigger_on_text_in_page": "auto_mode_trigger_on_text_in_page",
        "azure_openai_api_version": "azure_openai_api_version",
        "azure_openai_deployment_name": "azure_openai_deployment_name",
        "azure_openai_endpoint": "azure_openai_endpoint",
        "azure_openai_key": "azure_openai_key",
        "bbox_bottom": 0,
        "bbox_left": 0,
        "bbox_right": 0,
        "bbox_top": 0,
        "bounding_box": "bounding_box",
        "compact_markdown_table": true,
        "complemental_formatting_instruction": "complemental_formatting_instruction",
        "content_guideline_instruction": "content_guideline_instruction",
        "continuous_mode": true,
        "disable_image_extraction": true,
        "disable_ocr": true,
        "disable_reconstruction": true,
        "do_not_cache": true,
        "do_not_unroll_columns": true,
        "enable_cost_optimizer": true,
        "extract_charts": true,
        "extract_layout": true,
        "extract_printed_page_number": true,
        "fast_mode": true,
        "formatting_instruction": "formatting_instruction",
        "gpt4o_api_key": "gpt4o_api_key",
        "gpt4o_mode": true,
        "guess_xlsx_sheet_name": true,
        "hide_footers": true,
        "hide_headers": true,
        "high_res_ocr": true,
        "html_make_all_elements_visible": true,
        "html_remove_fixed_elements": true,
        "html_remove_navigation_elements": true,
        "http_proxy": "http_proxy",
        "ignore_document_elements_for_layout_detection": true,
        "images_to_save": [
          "screenshot"
        ],
        "inline_images_in_markdown": true,
        "input_s3_path": "input_s3_path",
        "input_s3_region": "input_s3_region",
        "input_url": "input_url",
        "internal_is_screenshot_job": true,
        "invalidate_cache": true,
        "is_formatting_instruction": true,
        "job_timeout_extra_time_per_page_in_seconds": 0,
        "job_timeout_in_seconds": 0,
        "keep_page_separator_when_merging_tables": true,
        "languages": [
          "af"
        ],
        "layout_aware": true,
        "line_level_bounding_box": true,
        "markdown_table_multiline_header_separator": "markdown_table_multiline_header_separator",
        "max_pages": 0,
        "max_pages_enforced": 0,
        "merge_tables_across_pages_in_markdown": true,
        "model": "model",
        "outlined_table_extraction": true,
        "output_pdf_of_document": true,
        "output_s3_path_prefix": "output_s3_path_prefix",
        "output_s3_region": "output_s3_region",
        "output_tables_as_HTML": true,
        "page_error_tolerance": 0,
        "page_footer_prefix": "page_footer_prefix",
        "page_footer_suffix": "page_footer_suffix",
        "page_header_prefix": "page_header_prefix",
        "page_header_suffix": "page_header_suffix",
        "page_prefix": "page_prefix",
        "page_separator": "page_separator",
        "page_suffix": "page_suffix",
        "parse_mode": "parse_page_without_llm",
        "parsing_instruction": "parsing_instruction",
        "precise_bounding_box": true,
        "premium_mode": true,
        "presentation_out_of_bounds_content": true,
        "presentation_skip_embedded_data": true,
        "preserve_layout_alignment_across_pages": true,
        "preserve_very_small_text": true,
        "preset": "preset",
        "priority": "low",
        "project_id": "project_id",
        "remove_hidden_text": true,
        "replace_failed_page_mode": "raw_text",
        "replace_failed_page_with_error_message_prefix": "replace_failed_page_with_error_message_prefix",
        "replace_failed_page_with_error_message_suffix": "replace_failed_page_with_error_message_suffix",
        "save_images": true,
        "skip_diagonal_text": true,
        "specialized_chart_parsing_agentic": true,
        "specialized_chart_parsing_efficient": true,
        "specialized_chart_parsing_plus": true,
        "specialized_image_parsing": true,
        "spreadsheet_extract_sub_tables": true,
        "spreadsheet_force_formula_computation": true,
        "strict_mode_buggy_font": true,
        "strict_mode_image_extraction": true,
        "strict_mode_image_ocr": true,
        "strict_mode_reconstruction": true,
        "structured_output": true,
        "structured_output_json_schema": "structured_output_json_schema",
        "structured_output_json_schema_name": "structured_output_json_schema_name",
        "system_prompt": "system_prompt",
        "system_prompt_append": "system_prompt_append",
        "take_screenshot": true,
        "target_pages": "target_pages",
        "tier": "tier",
        "use_vendor_multimodal_model": true,
        "user_prompt": "user_prompt",
        "vendor_multimodal_api_key": "vendor_multimodal_api_key",
        "vendor_multimodal_model_name": "vendor_multimodal_model_name",
        "version": "version",
        "webhook_configurations": [
          {
            "webhook_events": [
              "extract.pending"
            ],
            "webhook_headers": {
              "foo": "string"
            },
            "webhook_output_format": "webhook_output_format",
            "webhook_url": "webhook_url"
          }
        ],
        "webhook_url": "webhook_url"
      },
      "source_id": "source_id",
      "source_type": "source_type",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "version": "version",
      "creator": "creator"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}