Run Transforms
POST
/v1/transforms/run
Run transforms on input file, text, or URL
Request
Headers
An API Key is required to access this endpoint.
Name | Value |
---|---|
x-api-key |
|
Body
Either input file, text, or URL is required but not more than one.
Name | Type | Description |
---|---|---|
|
| File used for transforms. |
| string | Text used for transforms. |
| string | URL used for transforms. |
| string | Model used to run transform. |
| An array of transform objects. | |
| string | Unique ID for the webhook. |
Supported models can be found here.
Transform
Name | Type | Description |
---|---|---|
| Config options specific to the model. | |
| enum | Supported enums:
|
| string (optional) | Unique field name for the transform. Required with multiple transforms. |
Config
The config varies based on the type of model being used. CHAPTERIZE does not require a config.
Name | Type | Description |
---|---|---|
| string | String describing the transform. Does not support template literals. |
Name | Type | Description |
---|---|---|
| number | Number indicating summary length: 1 for short, 2 for medium, and 3 for long. |
| enum | Supported enums:
|
Name | Type | Description |
---|---|---|
| string | Source language for translation. Use two-letter lowercase abbreviation. |
| string | Target language for translation. Use two-letter lowercase abbreviation. |
Example
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