Run Extract
POST
/extract
Run extract based on the passed in request parameters
This is an asynchronous API endpoint. The initial request returns a jobId
and status
. You can use the jobId
to check the processing status and fetch results.
Request
Headers
An API Key is required to access this endpoint.
Name | Value |
---|---|
x-api-key |
|
Params
Either file or URL is required but not both. See Accepted File Types.
Name | Type | Description |
| file | File used for extraction |
| string | URL of the document used for extraction |
| JSON (optional) | JSON schema |
| boolean | Excludes OCR result from the response. Defaults to |
| boolean | Maintains format from the previous page. Defaults to |
| 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 a jobId
and status
. You can use this jobId
to check the processing status and fetch results.
Example
Last updated