Run Batch Transforms
POST
/v1/batches/transforms/run
Run multiple transforms on input file, text, or URL in a single call
Request
Headers
An API Key is required to access this endpoint.
Name | Value |
---|---|
x-api-key |
|
Body
At least one request object must be included.
Name | Type | Description |
---|---|---|
| Request[] | List of requests to include in the batch request. |
Request
Either input file, text, or URL is required but not more than one.
Name | Type | Description |
---|---|---|
| string | Text used for transforms. |
| string | Model used to run transform. |
| An array of transform objects. | |
| string (optional) | Unique ID for the webhook. |
Supported models can be found here.
Transform
Name | Type | Description |
---|---|---|
| enum | Supported enums:
|
| string (optional) | Unique field name for the transform. Required with multiple transforms. |
Example
Response
The API returns the response in JSON format.
The request will return a 200 with a batchId
and status
. You can use this batchId
to check the processing status and fetch results.
Example
Last updated