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

Retrieve voice consent

audio.voice_consents.retrieve(consent_id) -> VoiceConsent { id, created_at, language, 2 more }
GET
/audio/voice_consents/{consent_id}

Retrieves a voice consent recording.

Parameters
consent_id: String
Returns
class VoiceConsent { id, created_at, language, 2 more }

A consent recording used to authorize creation of a custom voice.

id: String

The consent recording identifier.

created_at: Integer

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

formatunixtime
language: String

The BCP 47 language tag for the consent phrase (for example, en-US).

name: String

The label provided when the consent recording was uploaded.

object: :"audio.voice_consent"

The object type, which is always audio.voice_consent.

Retrieve voice consent

require "openai"

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

voice_consent = openai.audio.voice_consents.retrieve("consent_id")

puts(voice_consent)
200 example
{
  "id": "cons_1234",
  "created_at": 0,
  "language": "language",
  "name": "name",
  "object": "audio.voice_consent"
}
Returns Examples
200 example
{
  "id": "cons_1234",
  "created_at": 0,
  "language": "language",
  "name": "name",
  "object": "audio.voice_consent"
}