POST
/
extract_async
Extract Async
import requests

url = "https://platform.reducto.ai/extract_async"

payload = {
    "options": {
        "ocr_mode": "standard",
        "extraction_mode": "ocr",
        "chunking": { "chunk_mode": "variable" },
        "table_summary": { "enabled": False },
        "figure_summary": {
            "enabled": False,
            "enhanced": False,
            "override": False
        },
        "filter_blocks": [],
        "force_url_result": False
    },
    "advanced_options": {
        "ocr_system": "highres",
        "table_output_format": "html",
        "merge_tables": False,
        "include_formula_information": False,
        "include_color_information": False,
        "continue_hierarchy": True,
        "keep_line_breaks": False,
        "page_range": {},
        "large_table_chunking": {
            "enabled": True,
            "size": 50
        },
        "spreadsheet_table_clustering": "default",
        "add_page_markers": False,
        "remove_text_formatting": False,
        "return_ocr_data": False,
        "filter_line_numbers": False,
        "read_comments": False,
        "persist_results": False,
        "exclude_hidden_sheets": False,
        "exclude_hidden_rows_cols": False,
        "enable_change_tracking": False,
        "enable_highlight_detection": False
    },
    "experimental_options": {
        "enrich": {
            "enabled": False,
            "mode": "standard"
        },
        "native_office_conversion": False,
        "enable_checkboxes": False,
        "enable_equations": False,
        "rotate_pages": True,
        "rotate_figures": False,
        "enable_scripts": False,
        "return_figure_images": False,
        "return_table_images": False,
        "layout_model": "default",
        "embed_text_metadata_pdf": False,
        "numerical_parse_confidence": False,
        "detect_signatures": False,
        "danger_filter_wide_boxes": False
    },
    "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,
    "include_images": False,
    "spreadsheet_agent": False,
    "experimental_table_citations": True,
    "priority": False,
    "citations_options": { "numerical_confidence": False },
    "document_url": "<string>",
    "webhook": {
        "mode": "disabled",
        "channels": []
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
{
  "job_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
schema
any
required

The JSON schema to use for extraction.

​
document_url
required

The URL of the document to be processed. You can provide one of the following:

  1. A publicly available URL
  2. A presigned S3 URL
  3. A reducto:// prefixed URL obtained from the /upload endpoint after directly uploading a document
  4. A job_id (jobid://) or a list of job_ids (jobid://) obtained from a previous /parse endpoint
​
options
object
​
advanced_options
object
​
experimental_options
object
​
system_prompt
string
default:Be precise and thorough.

A system prompt to use for the extraction. This is a general prompt that is applied to the entire document before any other prompts.

​
generate_citations
boolean
default:false

If citations should be generated for the extracted content.

​
array_extract
object

The configuration options for array extract

​
use_chunking
boolean
default:false

If chunking should be used for the extraction. Defaults to False.

​
include_images
boolean
default:false

If images should be passed directly for extractions. Can only be enabled for documents with less than 10 pages. Defaults to False.

​
spreadsheet_agent
boolean
default:false

If spreadsheet agent should be used for extraction.

​
experimental_table_citations
boolean
default:true

If table citations should be generated for the extracted content.

​
priority
boolean
default: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.

​
citations_options
object

The configuration options for citations.

​
webhook
object

Response

Successful Response

​
job_id
string
required