Extract

Run a Workflow against a document

Asynchronous. Returns immediately with a request_id; poll GET /files with that ID until request_status is completed, failed, or exception.

get/v1/documents/{document_id}/run_parser

Request

  • Base URL: https://api.documentpro.ai
  • URL: https://api.documentpro.ai/v1/documents/{document_id}/run_parser
  • Auth: API key in header x-api-key

Path parameters

document_idstring uuid required

Query parameters

template_idstring uuid required

The Workflow to run.

use_ocrboolean

Required true if query_model is gpt-3.5-turbo, or if using any OCR-related parameter below.

query_modelstring
Example:gpt-4o
detect_layoutboolean

Requires use_ocr=true.

detect_tablesboolean

Requires use_ocr=true.

page_rangesstring
Example:1-3,5,7-9
chunk_by_pagesinteger

Segmentation method 1: pages per segment.

rolling_windowinteger

Segmentation method 2: window size.

start_regexstring

Segmentation method 3. Requires use_ocr=true.

end_regexstring

Segmentation method 3. Requires use_ocr=true.

split_regexstring

Segmentation method 4. Requires use_ocr=true.

use_all_matchesboolean

Use all regex matches instead of just the first. Requires use_ocr=true.

Response

Parsing job initiated.

request_idstring uuid
request_status'pending' | 'processing' | 'completed' | 'failed' | 'exception'
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.