Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Bearer token authentication. Use your provider API key or Vikat authentication token. Virtual keys (prefixed with sk-vk-, or the legacy sk-bf-) can also be passed here.

Headers

x-vikat-async-job-result-ttl
integer
default:3600

Time-to-live in seconds for the job result after completion. Defaults to 3600 (1 hour). After expiry, the job result is automatically cleaned up.

Body

multipart/form-data
model
string
required

Model in provider/model format

file
file
required

Audio file to transcribe

fallbacks
string[]
stream
boolean
language
string
prompt
string
response_format
enum<string>
Available options:
json,
text,
srt,
verbose_json,
vtt
file_format
string

Response

Job accepted for processing

Response returned when creating or polling an async job

id
string
required

Unique identifier for the async job

status
enum<string>
required

The status of an async job

Available options:
pending,
processing,
completed,
failed
created_at
string<date-time>
required

When the job was created

expires_at
string<date-time>

When the job result expires and will be cleaned up

completed_at
string<date-time>

When the job completed (successfully or with failure)

status_code
integer

HTTP status code of the completed operation

result
any

The result of the completed operation (shape depends on the request type)

error
object

Error response from Vikat