Run Extract Sync
POST
/extract/sync
Run extract based on the passed in request parameters
This is a synchronous API endpoint. The request waits for the extraction process to complete and returns the result directly in the response.
Request
Headers
An API Key is required to access this endpoint.
x-api-key
your_api_key
Params
Either file or URL is required but not both. See Accepted File Types.
file
file
File used for extraction
url
string
URL of the document used for extraction
schema
JSON (optional)
JSON schema
excludeOCRResult
boolean (optional)
Excludes OCR result from the response. Defaults to false
maintainFormat
boolean (optional)
Maintains format from the previous page. Defaults to false
pageRange
number[] (optional)
Only run on a specific page range. Defaults to all pages.
Ex: pageRange=[1,2,3]
will run on the first three pages.
extractPerPage
string[] (optional)
Array of schema properties to extract data from each page and return an array of results. Good for applications with lots of repeated content. Defaults to []
webhookId
string (optional)
Unique ID for the webhook
Example JSON Schema
This is a JSON Schema, which defines the structure and validation rules for the JSON. For more examples and details, see JSON Schema Examples.
Response
The API returns the response in JSON format.
The request will return a 200 with the result
.
Example
Last updated