Audio

Create speech

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

POST
/v1/audio/speech
AuthorizationBearer <token>

Bearer token authentication. Use your MPilot virtual-key JWT or admin JWT. Virtual keys (prefixed with sk-bf-) can also be passed here.

In: header

modelstring

Model in provider/model format

inputstring

Text to convert to speech

fallbacks?array<string>
stream_format?string

Set to "sse" to enable streaming

Value in"sse"
voicestring | array<object>
instructions?string
response_format?string
Value in"mp3" | "opus" | "aac" | "flac" | "wav" | "pcm"
speed?number
Range0.25 <= value <= 4
language_code?string
pronunciation_dictionary_locators?array<object>
enable_logging?boolean
optimize_streaming_latency?boolean
with_timestamps?boolean

Response Body

curl -X POST "https://loading/{AI_GATEWAY_URL}/v1/audio/speech" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "input": "string",    "voice": "string"  }'
{
  "audio": "string",
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "total_tokens": 0
  },
  "alignment": {
    "char_start_times_ms": [
      0
    ],
    "char_end_times_ms": [
      0
    ],
    "characters": [
      "string"
    ]
  },
  "normalized_alignment": {
    "char_start_times_ms": [
      0
    ],
    "char_end_times_ms": [
      0
    ],
    "characters": [
      "string"
    ]
  },
  "audio_base64": "string",
  "extra_fields": {
    "request_type": "string",
    "provider": "openai",
    "model_requested": "string",
    "model_deployment": "string",
    "latency": 0,
    "chunk_index": 0,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "string",
      "hit_type": "string",
      "requested_provider": "string",
      "requested_model": "string",
      "provider_used": "string",
      "model_used": "string",
      "input_tokens": 0,
      "threshold": 0,
      "similarity": 0
    }
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
On this page

On this page

No Headings