Skip to main content

Upload File

POST 
/api/v1/parsing/upload

Upload a file to s3 and create a job. return a job id

Request​

Query Parameters

    project_id any
    organization_id any

Cookie Parameters

    session any

Body

    file

    object

    anyOf

    string

    annotate_links Annotate Links (boolean)
    Default value: false
    auto_mode Auto Mode (boolean)
    Default value: false
    auto_mode_trigger_on_image_in_page Auto Mode Trigger On Image In Page (boolean)
    Default value: false
    auto_mode_trigger_on_table_in_page Auto Mode Trigger On Table In Page (boolean)
    Default value: false
    auto_mode_trigger_on_text_in_page Auto Mode Trigger On Text In Page (string)
    auto_mode_trigger_on_regexp_in_page Auto Mode Trigger On Regexp In Page (string)
    azure_openai_api_version Azure Openai Api Version (string)
    azure_openai_deployment_name Azure Openai Deployment Name (string)
    azure_openai_endpoint Azure Openai Endpoint (string)
    azure_openai_key Azure Openai Key (string)
    bbox_bottom Bbox Bottom (number)
    bbox_left Bbox Left (number)
    bbox_right Bbox Right (number)
    bbox_top Bbox Top (number)
    continuous_mode Continuous Mode (boolean)
    Default value: false
    disable_ocr Disable Ocr (boolean)
    Default value: false
    disable_reconstruction Disable Reconstruction (boolean)
    Default value: false
    disable_image_extraction Disable Image Extraction (boolean)
    Default value: false
    do_not_cache Do Not Cache (boolean)
    Default value: false
    do_not_unroll_columns Do Not Unroll Columns (boolean)
    Default value: false
    extract_charts Extract Charts (boolean)
    Default value: false
    fast_mode Fast Mode (boolean)
    Default value: false
    guess_xlsx_sheet_name Guess Xlsx Sheet Name (boolean)
    Default value: false
    html_make_all_elements_visible Html Make All Elements Visible (boolean)
    Default value: false
    html_remove_fixed_elements Html Remove Fixed Elements (boolean)
    Default value: false
    html_remove_navigation_elements Html Remove Navigation Elements (boolean)
    Default value: false
    http_proxy Http Proxy (string)
    input_s3_path Input S3 Path (string)
    Default value:
    input_url Input Url (string)
    invalidate_cache Invalidate Cache (boolean)
    Default value: false
    is_formatting_instruction Is Formatting Instruction (boolean)
    Default value: true
    language ParserLanguages (string)[]

    Possible values: [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]

    Default value: ["en"]
    extract_layout Extract Layout (boolean)
    Default value: false

    max_pages

    object

    anyOf

    integer

    output_pdf_of_document Output Pdf Of Document (boolean)
    Default value: false
    output_s3_path_prefix Output S3 Path Prefix (string)
    Default value:
    page_prefix Page Prefix (string)
    Default value:
    page_separator Page Separator (string)
    page_suffix Page Suffix (string)
    Default value:
    parsing_instruction Parsing Instruction (string)
    Default value:
    premium_mode Premium Mode (boolean)
    Default value: false
    skip_diagonal_text Skip Diagonal Text (boolean)
    Default value: false
    structured_output Structured Output (boolean)
    Default value: false
    structured_output_json_schema Structured Output Json Schema (string)
    structured_output_json_schema_name Structured Output Json Schema Name (string)
    take_screenshot Take Screenshot (boolean)
    Default value: false
    target_pages Target Pages (string)
    Default value:
    use_vendor_multimodal_model Use Vendor Multimodal Model (boolean)
    Default value: false
    vendor_multimodal_api_key Vendor Multimodal Api Key (string)
    Default value:
    vendor_multimodal_model_name Vendor Multimodal Model Name (string)
    webhook_url Webhook Url (string)
    Default value:
    bounding_box Bounding Box (string)
    Default value:
    gpt4o_mode Gpt4O Mode (boolean)
    Default value: false
    gpt4o_api_key Gpt4O Api Key (string)
    Default value:

Responses​

Successful Response

Schema

    id uuidrequired
    status StatusEnum (string)required

    Enum for representing the status of a job

    Possible values: [PENDING, SUCCESS, ERROR, PARTIAL_SUCCESS]

    error_code

    object

    anyOf

    string

    error_message

    object

    anyOf

    string