Create speech

Generates audio from the input text. Returns audio data or streams via SSE.

POST /v1/audio/speech

Error

A valid request URL is required to generate request examples

200

"<string>"

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Authorizations

BearerAuthBasicAuthVirtualKeyAuthApiKeyAuth

Authorization · string · header · required

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

Body

application/json

model · string · required

Model in provider/model format

input · string · required

Text to convert to speech

voice · string object[] · required

fallbacks · string[]

stream_format · enum<string>

Set to "sse" to enable streaming

Available options: sse

instructions · string

response_format · enum<string>

Available options: mp3, opus, aac, flac, wav, pcm

speed · number

Required range: 0.25 <= x <= 4

language_code · string

pronunciation_dictionary_locators · object[]

Show child attributes

enable_logging · boolean

optimize_streaming_latency · boolean

with_timestamps · boolean

Response

200

audio/mpeg

Successful response

The response is of type file.