POST
/
v1
/
audio
/
generate

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to the Audio API (i.e. structured prediction).

batch
boolean
default:
true

Whether to process the document in batch mode (async).

callback_url
string | null

The URL to call when the request is completed.

Minimum length: 1
created_at
string

Date and time when the request was created (in UTC timezone)

domain
string
default:
audio.transcription

The domain identifier for the model.

Allowed value: "audio.transcription"
file_id
string | null

The ID of the uploaded file (provide either file_id or url).

id
string

Unique identifier of the request.

metadata
object | null

Optional metadata to pass to the model.

model
string
default:
vlm-1

The model to use for generating the response.

Allowed value: "vlm-1"
url
string | null

The URL of the file (provide either file_id or url).

Response

201 - application/json

Base prediction response for all API responses.

completed_at
string | null

Date and time when the response was completed (in UTC timezone)

created_at
string

Date and time when the request was created (in UTC timezone)

id
string

Unique identifier of the response.

response
any | null

The response from the model.

status
string
default:
pending

The status of the job.