Extract
import requests
url = "https://platform.reducto.ai/extract"
payload = {
"options": {
"ocr_mode": "standard",
"extraction_mode": "ocr",
"chunking": {
"chunk_mode": "variable",
"chunk_size": 123
},
"table_summary": {
"enabled": False,
"prompt": "<string>"
},
"figure_summary": {
"enabled": False,
"prompt": "<string>",
"override": False
},
"filter_blocks": ["Page Number", "Header", "Footer", "Comment"],
"force_url_result": False
},
"advanced_options": {
"ocr_system": "highres",
"table_output_format": "html",
"merge_tables": False,
"continue_hierarchy": True,
"keep_line_breaks": False,
"page_range": {
"start": 123,
"end": 123
},
"force_file_extension": "<string>",
"large_table_chunking": {
"enabled": True,
"size": 50
},
"spreadsheet_table_clustering": "default",
"add_page_markers": False,
"remove_text_formatting": False,
"return_ocr_data": False,
"document_password": "<string>",
"filter_line_numbers": False
},
"experimental_options": {
"enrich": {
"enabled": False,
"mode": "standard",
"prompt": "<string>"
},
"native_office_conversion": False,
"enable_checkboxes": False,
"enable_equations": False,
"rotate_pages": True,
"enable_underlines": False,
"enable_scripts": False,
"return_figure_images": False,
"return_table_images": False,
"danger_filter_wide_boxes": False
},
"document_url": "<string>",
"schema": "<any>",
"system_prompt": "Be precise and thorough.",
"generate_citations": False,
"array_extract": {
"enabled": False,
"mode": "legacy",
"pages_per_segment": 10,
"streaming_extract_item_density": 50
},
"use_chunking": False,
"priority": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text){
"usage": {
"num_pages": 123,
"num_fields": 123
},
"result": [
"<any>"
],
"citations": [
"<any>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The URL of the document to be processed. You can provide one of the following:
- A publicly available URL
- A presigned S3 URL
- A reducto:// prefixed URL obtained from the /upload endpoint after directly uploading a document
- A job_id (jobid://) or a list of job_ids (jobid://)
The JSON schema to use for extraction.
The mode to use for OCR. If agentic is enabled, at a small cost table OCR will be automatically edited.
standard, agentic The mode to use for extraction.
ocr, metadata, hybrid The configuration options for chunking.
The mode to use for chunking. Section chunks according to sections in the document. Page chunks according to pages. Page sections chunks according to both pages and sections. Disabled returns a single chunk.
variable, section, page, block, disabled, page_sections The approximate size of chunks (in characters) that the document will be split into. Defaults to None, in which case the chunk size is variable between 250 - 1500 characters.
The configuration options for figure summarization.
If figure summarization should be performed.
Add information to the prompt for figure summarization.
If the figure summary prompt should override our default prompt.
A list of block types to filter from chunk content.
Header, Footer, Title, Section Header, Page Number, List Item, Figure, Table, Key Value, Text, Comment, Discard Force the result to be returned in URL form (by default only used for very large responses).
The OCR system to use. Highres is recommended for documents with English characters.
highres, multilingual, combined The mode to use for table output. Dynamic returns md for simpler tables and html for more complex tables.
html, json, md, jsonbbox, dynamic, ai_json, csv A flag to indicate if consecutive tables with the same number of columns should be merged.
A flag to indicate if the hierarchy of the document should be continued from chunk to chunk.
If line breaks should be preserved in the text.
Force the URL to be downloaded as a specific file extension (e.g. .png).
The configuration options for large table chunking (currently only supported on spreadsheet and CSV files).
If large tables should be chunked into smaller tables, currently only supported on spreadsheet and CSV files.
The max row/column size for a table to be chunked. Defaults to 50. Header rows/columns are persisted based on heuristics.
On a spreadsheet, the algorithm that is used to split up sheets into multiple tables.
default, disabled If True, add page markers to the output (e.g. [[PAGE 1 BEGINS HERE]] and [[PAGE 1 ENDS HERE]] added as blocks to the content). Defaults to False.
If True, remove text formatting from the output (e.g. hyphens for list items). Defaults to False.
If True, return OCR data in the result. Defaults to False.
Password to decrypt password-protected documents.
If True, filter out line numbers from the output. Defaults to False.
The configuration options for enrichment.
If enabled, a large language/vision model will be used to postprocess the extracted content. Note: enabling enrich requires tables be outputted in markdown format. Defaults to False.
The mode to use for enrichment. Defaults to standard
standard, page Add information to the prompt for enrichment.
Instead of using LibreOffice, when enabled, this flag uses a Windows VM to convert files. This is slower but more accurate.
Use an experimental checkbox detection model to add checkboxes to the output, defaults to False
Use an experimental equation detection model to add equations to the output, defaults to False
Use an orientation model to detect and rotate pages as needed, defaults to True
Add <u> tag around text that's underlined and surround strikethroughs and underlines with <change> tags, defaults to False
Add <sub> tag around subscripts and <sup> tag around superscripts, defaults to False
If figure images should be returned in the result. Defaults to False.
If table images should be returned in the result. Defaults to False.
You probably shouldn't use this. If True, filter out boxes with width greater than 50% of the document width. Defaults to False. You probably don't want to use this.
A system prompt to use for the extraction. This is a general prompt that is applied to the entire document before any other prompts.
If citations should be generated for the extracted content.
The configuration options for array extract
Array extraction allows you to extract long lists of information from lengthy documents. It makes parallel calls on overlapping sections of the document.
The array extraction version to use.
auto, legacy, streaming, no_overlap Length of each segment, in pages, for parallel calls with array extraction.
Number of items to extract in each stream call. Lower numbers will increase quality but be much slower. 50 works well for most documents with tables.
If chunking should be used for the extraction. Defaults to False.
If True, attempts to process the job with priority if the user has priority processing budget available; by default, sync jobs are prioritized above async jobs.
Response
The extracted response in your provided schema. This is a list of dictionaries. If disbale_chunking is True (default), then it will be a list of length one.
The citations corresponding to the extracted response.
Was this page helpful?
import requests
url = "https://platform.reducto.ai/extract"
payload = {
"options": {
"ocr_mode": "standard",
"extraction_mode": "ocr",
"chunking": {
"chunk_mode": "variable",
"chunk_size": 123
},
"table_summary": {
"enabled": False,
"prompt": "<string>"
},
"figure_summary": {
"enabled": False,
"prompt": "<string>",
"override": False
},
"filter_blocks": ["Page Number", "Header", "Footer", "Comment"],
"force_url_result": False
},
"advanced_options": {
"ocr_system": "highres",
"table_output_format": "html",
"merge_tables": False,
"continue_hierarchy": True,
"keep_line_breaks": False,
"page_range": {
"start": 123,
"end": 123
},
"force_file_extension": "<string>",
"large_table_chunking": {
"enabled": True,
"size": 50
},
"spreadsheet_table_clustering": "default",
"add_page_markers": False,
"remove_text_formatting": False,
"return_ocr_data": False,
"document_password": "<string>",
"filter_line_numbers": False
},
"experimental_options": {
"enrich": {
"enabled": False,
"mode": "standard",
"prompt": "<string>"
},
"native_office_conversion": False,
"enable_checkboxes": False,
"enable_equations": False,
"rotate_pages": True,
"enable_underlines": False,
"enable_scripts": False,
"return_figure_images": False,
"return_table_images": False,
"danger_filter_wide_boxes": False
},
"document_url": "<string>",
"schema": "<any>",
"system_prompt": "Be precise and thorough.",
"generate_citations": False,
"array_extract": {
"enabled": False,
"mode": "legacy",
"pages_per_segment": 10,
"streaming_extract_item_density": 50
},
"use_chunking": False,
"priority": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text){
"usage": {
"num_pages": 123,
"num_fields": 123
},
"result": [
"<any>"
],
"citations": [
"<any>"
]
}