Parse Configurations
Create Parse Configuration
client.beta.parseConfigurations.create(ParseConfigurationCreateParams { name, parameters, version, 5 more } params, RequestOptionsoptions?): ParseConfiguration { id, created_at, name, 6 more }
POST/api/v1/beta/parse-configurations
List Parse Configurations
client.beta.parseConfigurations.list(ParseConfigurationListParams { creator, name, organization_id, 4 more } query?, RequestOptionsoptions?): PaginatedCursor<ParseConfiguration { id, created_at, name, 6 more } >
GET/api/v1/beta/parse-configurations
Get Parse Configuration
client.beta.parseConfigurations.get(stringconfigID, ParseConfigurationGetParams { organization_id, project_id } query?, RequestOptionsoptions?): ParseConfiguration { id, created_at, name, 6 more }
GET/api/v1/beta/parse-configurations/{config_id}
Update Parse Configuration
client.beta.parseConfigurations.update(stringconfigID, ParseConfigurationUpdateParams { organization_id, project_id, parameters } params, RequestOptionsoptions?): ParseConfiguration { id, created_at, name, 6 more }
PUT/api/v1/beta/parse-configurations/{config_id}
Delete Parse Configuration
client.beta.parseConfigurations.delete(stringconfigID, ParseConfigurationDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): void
DELETE/api/v1/beta/parse-configurations/{config_id}
ModelsExpand Collapse
ParseConfiguration { id, created_at, name, 6 more }
ParseConfiguration { id, created_at, name, 6 more }
Parse configuration schema.
id: string
id: string
Unique identifier for the parse configuration
created_at: string
created_at: string
Creation timestamp
formatdate-time
name: string
name: string
Name of the parse configuration
parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }
parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }
LlamaParseParameters configuration
adaptive_long_table?: boolean | null
aggressive_table_extraction?: boolean | null
annotate_links?: boolean | null
auto_mode?: boolean | null
auto_mode_configuration_json?: string | null
auto_mode_trigger_on_image_in_page?: boolean | null
auto_mode_trigger_on_regexp_in_page?: string | null
auto_mode_trigger_on_table_in_page?: boolean | null
auto_mode_trigger_on_text_in_page?: string | null
azure_openai_api_version?: string | null
azure_openai_deployment_name?: string | null
azure_openai_endpoint?: string | null
azure_openai_key?: string | null
bbox_bottom?: number | null
bbox_left?: number | null
bbox_right?: number | null
bbox_top?: number | null
bounding_box?: string | null
compact_markdown_table?: boolean | null
complemental_formatting_instruction?: string | null
content_guideline_instruction?: string | null
continuous_mode?: boolean | null
disable_image_extraction?: boolean | null
disable_ocr?: boolean | null
disable_reconstruction?: boolean | null
do_not_cache?: boolean | null
do_not_unroll_columns?: boolean | null
enable_cost_optimizer?: boolean | null
extract_charts?: boolean | null
extract_layout?: boolean | null
extract_printed_page_number?: boolean | null
fast_mode?: boolean | null
formatting_instruction?: string | null
gpt4o_api_key?: string | null
gpt4o_mode?: boolean | null
guess_xlsx_sheet_name?: boolean | null
hide_footers?: boolean | null
hide_headers?: boolean | null
high_res_ocr?: boolean | null
html_make_all_elements_visible?: boolean | null
html_remove_fixed_elements?: boolean | null
html_remove_navigation_elements?: boolean | null
http_proxy?: string | null
ignore_document_elements_for_layout_detection?: boolean | null
images_to_save?: Array<"screenshot" | "embedded" | "layout"> | null
images_to_save?: Array<"screenshot" | "embedded" | "layout"> | null
Accepts one of the following:
"screenshot"
"embedded"
"layout"
inline_images_in_markdown?: boolean | null
input_s3_path?: string | null
input_s3_region?: string | null
input_url?: string | null
internal_is_screenshot_job?: boolean | null
invalidate_cache?: boolean | null
is_formatting_instruction?: boolean | null
job_timeout_extra_time_per_page_in_seconds?: number | null
job_timeout_in_seconds?: number | null
keep_page_separator_when_merging_tables?: boolean | null
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?: boolean | null
line_level_bounding_box?: boolean | null
markdown_table_multiline_header_separator?: string | null
max_pages?: number | null
max_pages_enforced?: number | null
merge_tables_across_pages_in_markdown?: boolean | null
model?: string | null
outlined_table_extraction?: boolean | null
output_pdf_of_document?: boolean | null
output_s3_path_prefix?: string | null
output_s3_region?: string | null
output_tables_as_HTML?: boolean | null
page_error_tolerance?: number | null
page_footer_prefix?: string | null
page_footer_suffix?: string | null
page_header_prefix?: string | null
page_header_suffix?: string | null
page_prefix?: string | null
page_separator?: string | null
page_suffix?: string | null
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?: string | null
precise_bounding_box?: boolean | null
premium_mode?: boolean | null
presentation_out_of_bounds_content?: boolean | null
presentation_skip_embedded_data?: boolean | null
preserve_layout_alignment_across_pages?: boolean | null
preserve_very_small_text?: boolean | null
preset?: string | null
priority?: "low" | "medium" | "high" | "critical" | null
priority?: "low" | "medium" | "high" | "critical" | null
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?: string | null
remove_hidden_text?: boolean | null
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?: string | null
replace_failed_page_with_error_message_suffix?: string | null
save_images?: boolean | null
skip_diagonal_text?: boolean | null
specialized_chart_parsing_agentic?: boolean | null
specialized_chart_parsing_efficient?: boolean | null
specialized_chart_parsing_plus?: boolean | null
specialized_image_parsing?: boolean | null
spreadsheet_extract_sub_tables?: boolean | null
spreadsheet_force_formula_computation?: boolean | null
strict_mode_buggy_font?: boolean | null
strict_mode_image_extraction?: boolean | null
strict_mode_image_ocr?: boolean | null
strict_mode_reconstruction?: boolean | null
structured_output?: boolean | null
structured_output_json_schema?: string | null
structured_output_json_schema_name?: string | null
system_prompt?: string | null
system_prompt_append?: string | null
take_screenshot?: boolean | null
target_pages?: string | null
tier?: string | null
use_vendor_multimodal_model?: boolean | null
user_prompt?: string | null
vendor_multimodal_api_key?: string | null
vendor_multimodal_model_name?: string | null
version?: string | null
webhook_configurations?: Array<WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url } > | null
webhook_configurations?: Array<WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url } > | null
The outbound webhook configurations
webhook_events?: Array<"extract.pending" | "extract.success" | "extract.error" | 13 more> | null
webhook_events?: Array<"extract.pending" | "extract.success" | "extract.error" | 13 more> | null
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?: Record<string, string> | null
webhook_headers?: Record<string, string> | null
Custom HTTP headers to include with webhook requests.
webhook_output_format?: string | null
webhook_output_format?: string | null
The output format to use for the webhook. Defaults to string if none supplied. Currently supported values: string, json
webhook_url?: string | null
webhook_url?: string | null
The URL to send webhook notifications to.
webhook_url?: string | null
source_id: string
source_id: string
ID of the source
source_type: string
source_type: string
Type of the source (e.g., 'project')
updated_at: string
updated_at: string
Last update timestamp
formatdate-time
version: string
version: string
Version of the configuration
creator?: string | null
creator?: string | null
Creator of the configuration
ParseConfigurationCreate { name, parameters, version, 3 more }
ParseConfigurationCreate { name, parameters, version, 3 more }
Schema for creating a new parse configuration (API boundary).
name: string
name: string
Name of the parse configuration
parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }
parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }
LlamaParseParameters configuration
adaptive_long_table?: boolean | null
aggressive_table_extraction?: boolean | null
annotate_links?: boolean | null
auto_mode?: boolean | null
auto_mode_configuration_json?: string | null
auto_mode_trigger_on_image_in_page?: boolean | null
auto_mode_trigger_on_regexp_in_page?: string | null
auto_mode_trigger_on_table_in_page?: boolean | null
auto_mode_trigger_on_text_in_page?: string | null
azure_openai_api_version?: string | null
azure_openai_deployment_name?: string | null
azure_openai_endpoint?: string | null
azure_openai_key?: string | null
bbox_bottom?: number | null
bbox_left?: number | null
bbox_right?: number | null
bbox_top?: number | null
bounding_box?: string | null
compact_markdown_table?: boolean | null
complemental_formatting_instruction?: string | null
content_guideline_instruction?: string | null
continuous_mode?: boolean | null
disable_image_extraction?: boolean | null
disable_ocr?: boolean | null
disable_reconstruction?: boolean | null
do_not_cache?: boolean | null
do_not_unroll_columns?: boolean | null
enable_cost_optimizer?: boolean | null
extract_charts?: boolean | null
extract_layout?: boolean | null
extract_printed_page_number?: boolean | null
fast_mode?: boolean | null
formatting_instruction?: string | null
gpt4o_api_key?: string | null
gpt4o_mode?: boolean | null
guess_xlsx_sheet_name?: boolean | null
hide_footers?: boolean | null
hide_headers?: boolean | null
high_res_ocr?: boolean | null
html_make_all_elements_visible?: boolean | null
html_remove_fixed_elements?: boolean | null
html_remove_navigation_elements?: boolean | null
http_proxy?: string | null
ignore_document_elements_for_layout_detection?: boolean | null
images_to_save?: Array<"screenshot" | "embedded" | "layout"> | null
images_to_save?: Array<"screenshot" | "embedded" | "layout"> | null
Accepts one of the following:
"screenshot"
"embedded"
"layout"
inline_images_in_markdown?: boolean | null
input_s3_path?: string | null
input_s3_region?: string | null
input_url?: string | null
internal_is_screenshot_job?: boolean | null
invalidate_cache?: boolean | null
is_formatting_instruction?: boolean | null
job_timeout_extra_time_per_page_in_seconds?: number | null
job_timeout_in_seconds?: number | null
keep_page_separator_when_merging_tables?: boolean | null
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?: boolean | null
line_level_bounding_box?: boolean | null
markdown_table_multiline_header_separator?: string | null
max_pages?: number | null
max_pages_enforced?: number | null
merge_tables_across_pages_in_markdown?: boolean | null
model?: string | null
outlined_table_extraction?: boolean | null
output_pdf_of_document?: boolean | null
output_s3_path_prefix?: string | null
output_s3_region?: string | null
output_tables_as_HTML?: boolean | null
page_error_tolerance?: number | null
page_footer_prefix?: string | null
page_footer_suffix?: string | null
page_header_prefix?: string | null
page_header_suffix?: string | null
page_prefix?: string | null
page_separator?: string | null
page_suffix?: string | null
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?: string | null
precise_bounding_box?: boolean | null
premium_mode?: boolean | null
presentation_out_of_bounds_content?: boolean | null
presentation_skip_embedded_data?: boolean | null
preserve_layout_alignment_across_pages?: boolean | null
preserve_very_small_text?: boolean | null
preset?: string | null
priority?: "low" | "medium" | "high" | "critical" | null
priority?: "low" | "medium" | "high" | "critical" | null
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?: string | null
remove_hidden_text?: boolean | null
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?: string | null
replace_failed_page_with_error_message_suffix?: string | null
save_images?: boolean | null
skip_diagonal_text?: boolean | null
specialized_chart_parsing_agentic?: boolean | null
specialized_chart_parsing_efficient?: boolean | null
specialized_chart_parsing_plus?: boolean | null
specialized_image_parsing?: boolean | null
spreadsheet_extract_sub_tables?: boolean | null
spreadsheet_force_formula_computation?: boolean | null
strict_mode_buggy_font?: boolean | null
strict_mode_image_extraction?: boolean | null
strict_mode_image_ocr?: boolean | null
strict_mode_reconstruction?: boolean | null
structured_output?: boolean | null
structured_output_json_schema?: string | null
structured_output_json_schema_name?: string | null
system_prompt?: string | null
system_prompt_append?: string | null
take_screenshot?: boolean | null
target_pages?: string | null
tier?: string | null
use_vendor_multimodal_model?: boolean | null
user_prompt?: string | null
vendor_multimodal_api_key?: string | null
vendor_multimodal_model_name?: string | null
version?: string | null
webhook_configurations?: Array<WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url } > | null
webhook_configurations?: Array<WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url } > | null
The outbound webhook configurations
webhook_events?: Array<"extract.pending" | "extract.success" | "extract.error" | 13 more> | null
webhook_events?: Array<"extract.pending" | "extract.success" | "extract.error" | 13 more> | null
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?: Record<string, string> | null
webhook_headers?: Record<string, string> | null
Custom HTTP headers to include with webhook requests.
webhook_output_format?: string | null
webhook_output_format?: string | null
The output format to use for the webhook. Defaults to string if none supplied. Currently supported values: string, json
webhook_url?: string | null
webhook_url?: string | null
The URL to send webhook notifications to.
webhook_url?: string | null
version: string
version: string
Version of the configuration
creator?: string | null
creator?: string | null
Creator of the configuration
source_id?: string | null
source_id?: string | null
ID of the source
source_type?: string | null
source_type?: string | null
Type of the source (e.g., 'project')
ParseConfigurationQueryResponse { items, next_page_token, total_size }
ParseConfigurationQueryResponse { items, next_page_token, total_size }
Response schema for paginated parse configuration queries.
The list of items.
id: string
id: string
Unique identifier for the parse configuration
created_at: string
created_at: string
Creation timestamp
formatdate-time
name: string
name: string
Name of the parse configuration
parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }
parameters: LlamaParseParameters { adaptive_long_table, aggressive_table_extraction, annotate_links, 115 more }
LlamaParseParameters configuration
adaptive_long_table?: boolean | null
aggressive_table_extraction?: boolean | null
annotate_links?: boolean | null
auto_mode?: boolean | null
auto_mode_configuration_json?: string | null
auto_mode_trigger_on_image_in_page?: boolean | null
auto_mode_trigger_on_regexp_in_page?: string | null
auto_mode_trigger_on_table_in_page?: boolean | null
auto_mode_trigger_on_text_in_page?: string | null
azure_openai_api_version?: string | null
azure_openai_deployment_name?: string | null
azure_openai_endpoint?: string | null
azure_openai_key?: string | null
bbox_bottom?: number | null
bbox_left?: number | null
bbox_right?: number | null
bbox_top?: number | null
bounding_box?: string | null
compact_markdown_table?: boolean | null
complemental_formatting_instruction?: string | null
content_guideline_instruction?: string | null
continuous_mode?: boolean | null
disable_image_extraction?: boolean | null
disable_ocr?: boolean | null
disable_reconstruction?: boolean | null
do_not_cache?: boolean | null
do_not_unroll_columns?: boolean | null
enable_cost_optimizer?: boolean | null
extract_charts?: boolean | null
extract_layout?: boolean | null
extract_printed_page_number?: boolean | null
fast_mode?: boolean | null
formatting_instruction?: string | null
gpt4o_api_key?: string | null
gpt4o_mode?: boolean | null
guess_xlsx_sheet_name?: boolean | null
hide_footers?: boolean | null
hide_headers?: boolean | null
high_res_ocr?: boolean | null
html_make_all_elements_visible?: boolean | null
html_remove_fixed_elements?: boolean | null
html_remove_navigation_elements?: boolean | null
http_proxy?: string | null
ignore_document_elements_for_layout_detection?: boolean | null
images_to_save?: Array<"screenshot" | "embedded" | "layout"> | null
images_to_save?: Array<"screenshot" | "embedded" | "layout"> | null
Accepts one of the following:
"screenshot"
"embedded"
"layout"
inline_images_in_markdown?: boolean | null
input_s3_path?: string | null
input_s3_region?: string | null
input_url?: string | null
internal_is_screenshot_job?: boolean | null
invalidate_cache?: boolean | null
is_formatting_instruction?: boolean | null
job_timeout_extra_time_per_page_in_seconds?: number | null
job_timeout_in_seconds?: number | null
keep_page_separator_when_merging_tables?: boolean | null
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?: boolean | null
line_level_bounding_box?: boolean | null
markdown_table_multiline_header_separator?: string | null
max_pages?: number | null
max_pages_enforced?: number | null
merge_tables_across_pages_in_markdown?: boolean | null
model?: string | null
outlined_table_extraction?: boolean | null
output_pdf_of_document?: boolean | null
output_s3_path_prefix?: string | null
output_s3_region?: string | null
output_tables_as_HTML?: boolean | null
page_error_tolerance?: number | null
page_footer_prefix?: string | null
page_footer_suffix?: string | null
page_header_prefix?: string | null
page_header_suffix?: string | null
page_prefix?: string | null
page_separator?: string | null
page_suffix?: string | null
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?: string | null
precise_bounding_box?: boolean | null
premium_mode?: boolean | null
presentation_out_of_bounds_content?: boolean | null
presentation_skip_embedded_data?: boolean | null
preserve_layout_alignment_across_pages?: boolean | null
preserve_very_small_text?: boolean | null
preset?: string | null
priority?: "low" | "medium" | "high" | "critical" | null
priority?: "low" | "medium" | "high" | "critical" | null
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?: string | null
remove_hidden_text?: boolean | null
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?: string | null
replace_failed_page_with_error_message_suffix?: string | null
save_images?: boolean | null
skip_diagonal_text?: boolean | null
specialized_chart_parsing_agentic?: boolean | null
specialized_chart_parsing_efficient?: boolean | null
specialized_chart_parsing_plus?: boolean | null
specialized_image_parsing?: boolean | null
spreadsheet_extract_sub_tables?: boolean | null
spreadsheet_force_formula_computation?: boolean | null
strict_mode_buggy_font?: boolean | null
strict_mode_image_extraction?: boolean | null
strict_mode_image_ocr?: boolean | null
strict_mode_reconstruction?: boolean | null
structured_output?: boolean | null
structured_output_json_schema?: string | null
structured_output_json_schema_name?: string | null
system_prompt?: string | null
system_prompt_append?: string | null
take_screenshot?: boolean | null
target_pages?: string | null
tier?: string | null
use_vendor_multimodal_model?: boolean | null
user_prompt?: string | null
vendor_multimodal_api_key?: string | null
vendor_multimodal_model_name?: string | null
version?: string | null
webhook_configurations?: Array<WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url } > | null
webhook_configurations?: Array<WebhookConfiguration { webhook_events, webhook_headers, webhook_output_format, webhook_url } > | null
The outbound webhook configurations
webhook_events?: Array<"extract.pending" | "extract.success" | "extract.error" | 13 more> | null
webhook_events?: Array<"extract.pending" | "extract.success" | "extract.error" | 13 more> | null
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?: Record<string, string> | null
webhook_headers?: Record<string, string> | null
Custom HTTP headers to include with webhook requests.
webhook_output_format?: string | null
webhook_output_format?: string | null
The output format to use for the webhook. Defaults to string if none supplied. Currently supported values: string, json
webhook_url?: string | null
webhook_url?: string | null
The URL to send webhook notifications to.
webhook_url?: string | null
source_id: string
source_id: string
ID of the source
source_type: string
source_type: string
Type of the source (e.g., 'project')
updated_at: string
updated_at: string
Last update timestamp
formatdate-time
version: string
version: string
Version of the configuration
creator?: string | null
creator?: string | null
Creator of the configuration
next_page_token?: string | null
next_page_token?: string | null
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?: number | null
total_size?: number | null
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.