Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Create voice

audio.voices.create(**kwargs) -> Voice { id, created_at, name, 2 more }
POST/audio/voices

Creates a voice from a text prompt or from a consent recording and an audio sample.

For prompt-based creation, send type: "prompt" with a name and prompt as JSON or multipart form data. For creation from an audio sample, send type: "audio_sample" with a name, audio_sample, and consent recording ID as multipart form data. The type defaults to audio_sample when omitted.

Returns the saved voice’s metadata. Voices created from text prompts are supported only in Live, not in Realtime or the speech endpoint. The response does not include preview audio.

ParametersExpand Collapse
body: AudioSample{ audio_sample, consent, name, type} | Prompt{ name, prompt, type, 2 more}

Creates a voice from a consent recording and an audio sample. Requires multipart/form-data.

One of the following:
class AudioSample { audio_sample, consent, name, type }

Creates a voice from a consent recording and an audio sample. Requires multipart/form-data.

class Prompt { name, prompt, type, 2 more }

Creates a synthetic voice from a text description. Supports application/json or multipart/form-data.

ReturnsExpand Collapse
class Voice { id, created_at, name, 2 more }

A custom voice that can be used for audio output. Voices created from text prompts are supported only in Live.

id: String

The voice identifier, which can be referenced in API endpoints.

created_at: Integer

The Unix timestamp (in seconds) for when the voice was created.

formatunixtime
name: String

The name of the voice.

object: :"audio.voice"

The object type, which is always audio.voice.

type: :audio_sample | :prompt

How the voice was created. Voices created from text prompts are supported only in Live.

Create voice

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

voice = openai.audio.voices.create(
  body: {audio_sample: StringIO.new("Example data"), consent: "consent", name: "x"}
)

puts(voice)
{
  "id": "id",
  "created_at": 0,
  "name": "name",
  "object": "audio.voice",
  "type": "audio_sample"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "name": "name",
  "object": "audio.voice",
  "type": "audio_sample"
}