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

List voice consents

audio.voice_consents.list(**kwargs) -> SyncCursorPage[VoiceConsent]
GET
/audio/voice_consents

Returns a list of voice consent recordings.

Parameters
after: Optional[str]

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

limit: Optional[int]

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Returns
class VoiceConsent: …

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

id: str

The consent recording identifier.

created_at: int

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

formatunixtime
language: str

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

name: str

The label provided when the consent recording was uploaded.

object: Literal["audio.voice_consent"]

The object type, which is always audio.voice_consent.

List voice consents

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
page = client.audio.voice_consents.list()
page = page.data[0]
print(page.id)
200 example
{
  "data": [
    {
      "id": "cons_1234",
      "created_at": 0,
      "language": "language",
      "name": "name",
      "object": "audio.voice_consent"
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "first_id",
  "last_id": "last_id"
}
Returns Examples
200 example
{
  "data": [
    {
      "id": "cons_1234",
      "created_at": 0,
      "language": "language",
      "name": "name",
      "object": "audio.voice_consent"
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "first_id",
  "last_id": "last_id"
}