Audio

Converts text into spoken audio and charges the account for what it counted. Requires an API key.

post/v1/audio/speech

Request

Request body

modelstring required

The speech model to synthesise with, named by its id or alias.

inputstring required

The text to read aloud, at most 32768 Unicode characters.

voicestring required

The voice to read in, by the name the model knows it under.

speednumber double nullable

How fast to read, as a multiplier of the model's normal pace. Zero or less draws a 400.

instructionsstring nullable

Free-form direction for how the text should be delivered.

response_format'mp3' | 'opus' | 'aac' | 'flac' | 'wav' | 'pcm' nullable

The audio container to synthesise into, which also sets the answer's Content-Type.

Response

The synthesised audio itself, streamed as it is produced. Content-Type names the container response_format asked for, or audio/mpeg when the key was left out and the provider named none of its own.

Changes

    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • breaking

      the request property type changed from number to number null, and format from no format to double

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id createSpeech removed and replaced with create_speech

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added subschema #1 subschema #2 to the request property oneOf list

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added the required property to the response with the status