Skip to main content
POST
Generate audio transcription

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

audio_id
string
required
Pattern: ^a-
Example:

"a-12345"

Body

application/json
engine
string
default:default
Example:

"default"

language_code
string
default:en
Example:

"en"

force
boolean
default:false
Example:

false

callback_url
string
Example:

"https://webhook.example.com/callback"

callback_data
object

Response

200 - application/json

Transcription job started

success
boolean
Example:

true

status
enum<string>
Available options:
processing,
done,
failed
Example:

"processing"

data
object