Async Parse

POST /parse_async

Try it

Async Parse

Python

import requests

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

payload = {
    "input": "<string>",
    "async": { "priority": False },
    "enhance": {
        "agentic": [],
        "summarize_figures": True
    },
    "retrieval": {
        "chunking": { "chunk_mode": "disabled" },
        "filter_blocks": [],
        "embedding_optimized": False
    },
    "formatting": {
        "add_page_markers": False,
        "table_output_format": "dynamic",
        "merge_tables": False,
        "include": []
    },
    "spreadsheet": {
        "split_large_tables": {
            "enabled": True,
            "size": 50
        },
        "include": [],
        "clustering": "accurate",
        "exclude": []
    },
    "settings": {
        "ocr_system": "standard",
        "force_url_result": False,
        "return_ocr_data": False,
        "return_images": [],
        "embed_pdf_metadata": False,
        "persist_results": False
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())

200

{
  "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

input · required

For parse/split/extract pipelines, 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 jobid:// prefixed URL obtained from a previous /parse invocation

For edit pipelines, this should be a string containing the edit instructions

async · AsyncConfig · object

The configuration options for asynchronous processing (default synchronous).

Show child attributes

async. metadata · any

JSON metadata included in webhook request body. Defaults to None.

async. 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.

async. webhook · SvixWebhookConfig · object

The webhook configuration for the asynchronous processing.

SvixWebhookConfig

Show child attributes

async.webhook. mode · string · default: svix

Allowed value: "svix"

async.webhook. channels · string[]

A list of Svix channels the message will be delivered down, omit to send to all channels.

enhance · Enhance · object

Show child attributes

enhance. agentic · (TableAgentic · object | FigureAgentic · object | TextAgentic · object)[]

Agentic uses vision language models to enhance the accuracy of the output of different types of extraction. This will incur a cost and latency increase.

TableAgentic

Show child attributes

enhance.agentic. scope · string · required

Allowed value: "table"

enhance.agentic. prompt · string | null

Custom prompt for table agentic.

enhance. summarize_figures · boolean · default: true

If True, summarize figures using a small vision language model. Defaults to True.

retrieval · Retrieval · object

Show child attributes

retrieval. chunking · Chunking · object

Show child attributes

retrieval.chunking. chunk_mode · enum<string> · default: disabled

Choose how to partition chunks. Variable mode chunks by character length and visual context. Section mode chunks by section headers. Page mode chunks according to pages. Page sections mode chunks first by page, then by sections within each page. Disabled returns one single chunk.

Available options: variable, section, page, disabled, block, page_sections

retrieval.chunking. chunk_size · integer | null

The approximate size of chunks (in characters) that the document will be split into. Defaults to null, in which case the chunk size is variable between 250 - 1500 characters.

retrieval. filter_blocks · enum<string>[]

A list of block types to filter out from 'content' and 'embed' fields. By default, no blocks are filtered.

Available options: Header, Footer, Title, Section Header, Page Number, List Item, Figure, Table, Key Value, Text, Comment, Signature

retrieval. embedding_optimized · boolean · default: false

If True, use embedding optimized mode. Defaults to False.

formatting · Formatting · object

Show child attributes

formatting. add_page_markers · boolean · default: false

If True, add page markers to the output. Defaults to False. Useful for extracting data with page specific information.

formatting. table_output_format · enum<string> · default: dynamic

The mode to use for table output. Defaults to dynamic, which returns md for simpler tables and html for more complex tables.

Available options: html, json, md, jsonbbox, dynamic, csv

formatting. merge_tables · boolean · default: false

A flag to indicate if consecutive tables with the same number of columns should be merged. Defaults to False.

formatting. include · enum<string>[]

A list of formatting to include in the output. [insert description of each option here later]

Available options: change_tracking, highlight, comments, hyperlinks

spreadsheet · Spreadsheet · object

Show child attributes

spreadsheet. split_large_tables · SplitLargeTables · object

Show child attributes

spreadsheet.split_large_tables. enabled · boolean · default: true

If True, split large tables into smaller tables. Defaults to True.

spreadsheet.split_large_tables. size · integer · default: 50

The size of the tables to split into. Defaults to 50.

spreadsheet. include · enum<string>[]

Whether to include cell color and formula information in the output.

Available options: cell_colors, formula

spreadsheet. clustering · enum<string> · default: accurate

In a spreadsheet with different tables inside, we enable splitting up the tables by default. Accurate mode applies more powerful models for superior accuracy, at 5× the default per-cell rate. Disabling will register as one large table.

Available options: accurate, fast, disabled

spreadsheet. exclude · enum<string>[]

Whether to exclude hidden sheets, rows, or columns in the output.

Available options: hidden_sheets, hidden_rows, hidden_cols

settings · Settings · object

Show child attributes

settings. ocr_system · enum<string> · default: standard

Standard is our best multilingual OCR system. Legacy only supports germanic languages and is available for backwards compatibility.

Available options: standard, legacy

settings. force_url_result · boolean · default: false

Force the result to be returned in URL form.

settings. force_file_extension · string | null

Force the URL to be downloaded as a specific file extension (e.g. .png).

settings. return_ocr_data · boolean · default: false

If True, return OCR data in the result. Defaults to False.

settings. return_images · enum<string>[]

Whether to return images for the specified block types. By default, no images are returned.

Available options: figure, table

settings. embed_pdf_metadata · boolean · default: false

If True, embed OCR metadata into the returned PDF. Defaults to False.

settings. persist_results · boolean · default: false

If True, persist the results indefinitely. Defaults to False.

settings. timeout · number | null

The timeout for the job in seconds.

settings. page_range

The page range to process (1-indexed). By default, the entire document is processed.

Show child attributes

settings.page_range. start · integer | null

The page number to start processing from (1-indexed).

settings.page_range. end · integer | null

The page number to stop processing at (1-indexed).

settings. document_password · string | null

Password to decrypt password-protected documents.

Response

200

application/json

Successful Response

job_id · string · required