API Reference
Create a job
Queues a recording for processing and returns the job.
POST
/v1/jobsSend JSON. Name the recording with file_id (a file uploaded through POST /v1/files) or pass a public url. Exactly one of the two is required.
The API measures the duration, prices the job and reserves that amount on the balance. If the balance or a monthly limit does not cover it, the job is refused at once with 402.
Parameters
modelstringrequired- Model version, for example
kezek-1. file_idstring- ID of an uploaded file. Required unless
urlis set. urlstring- Public https link to the recording. Required unless
file_idis set. cleanupstringnone(default),cleanorstudio.output_formatstringwav(default),flacormp3.outputstringmono_pair(default) orstereo.sample_rateinteger- 16000, 24000, 44100 or 48000. Defaults to the input rate.
Errors
| Code | Status | Meaning |
|---|---|---|
unsupported_format | 400 | The file is not a supported audio format. |
file_too_long | 400 | The recording is longer than 4 hours. |
insufficient_balance | 402 | The balance does not cover the job. |
monthly_limit_exceeded | 402 | The organization's or the key's monthly limit is reached. |
model_not_allowed | 403 | The key is not allowed to use this model. |
invalid_api_key | 401 | The key is missing, revoked or expired. |
rate_limited | 429 | Too many requests. Retry after the Retry-After header. |