BreezeDocs
DocumentationAPI reference
/
Sign inGet API key

Documentation

  • Introduction
  • Quickstart
  • Authentication
  • Voices
  • Output formats
  • Streaming
  • Pricing
  • Text to speech
  • Designing a voice
  • Cloning a voice
  • Managing history
  • Errors
  • Rate limits

API reference

  • API reference
  • Introduction
  • GETList models
  • POSTConvert text to speech
  • GETGet generation job
  • GETDownload generation job audio
  • POSTStream text to speech
  • POSTAI rewrite text to speech instruction
  • GETList voices
  • GETGet a random voice
  • GETGet a voice
  • PATCHEdit a voice
  • GETGet voice settings
  • PATCHUpdate voice settings
  • DELDelete a voice
  • POSTCreate clone preview
  • POSTCreate design previews
  • GETStream voice preview
  • POSTSave voice preview
  • GETList history items
  • GETGet a history item
  • GETDownload history audio
  • DELDelete a history item
  • GETGet account balance
  • GETGet account entitlements
  • GETGet usage metering
  • GETList API keys
  • POSTCreate an API key
  • PATCHRename an API key
  • DELDelete an API key
  • POSTDisable an API key
  • POSTEnable an API key
  • POSTRotate an API key

Streaming

Breeze supports both POST /v1/text-to-speech/{voice_id} (non-streaming) and POST /v1/text-to-speech/{voice_id}/stream (streaming).

Use the streaming endpoint for lower time-to-first-byte and chunked audio. Supports mp3 and pcm output formats.

Timing metadata and realtime text input over WebSocket are planned.