Skip to main content
POST
For all supported audio domains, see the Hub Catalog.

Example Output

Example Audio Transcription

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).

domain
required

The domain identifier for the model (e.g. audio.transcription).

Available options:
audio.transcription,
audio.transcription-summary
metadata
RequestMetadata · object

Optional metadata to pass to the model.

config
GenerationConfig · object

The VLM generation config to be used for //generate.

url
string | null

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

file_id
string | null

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

id
string

Unique identifier of the request.

created_at
string<date-time>

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

callback_url
string<uri> | null

The URL to call when the request is completed.

Minimum string length: 1
model
default:vlm-1

The model to use for generating the response.

Available options:
vlm-1,
vlm-1:auto,
vlm-1:fast,
vlm-1:pro
batch
boolean
default:true

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

Response

Successful Response