About this endpoint
What it does
Uploads a document file and runs document extraction using the requested service. The response returns a JSON object with a data object that may contain extracted results under azure or apyhub, depending on requested_service.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | The document file to upload. Binary file input. |
| azure_key | String | No | Azure key used when requested_service is azure. |
| azure_endpoint | String | No | Azure endpoint used when requested_service is azure. |
| requested_service | ENUM | Yes | The extraction service to use. Allowed values: azure, apyhub. |
Response
Returns a JSON object with a data object field. Inside data, the schema defines optional azure and apyhub object fields, which contain the extraction result for the corresponding service when present.
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Wrapper object for the extraction result. |
| data.azure | Object | No | Present when requested_service is azure. Contains the Azure extraction result; the schema allows additional properties. |
| data.apyhub | Object | No | Present when requested_service is apyhub. Contains the ApyHub extraction result; the schema allows additional properties. |