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.

Retrieve voice consent

VoiceConsent audio().voiceConsents().retrieve(

params = VoiceConsentRetrieveParams.none()

,

requestOptions = RequestOptions.none()

)

GET

/audio/voice_consents/{consent_id}

Retrieves a voice consent recording.

Parameters

VoiceConsentRetrieveParams params

Optional<String> consentId

Returns

class VoiceConsent:

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

String id

The consent recording identifier.

long createdAt

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

formatunixtime

String language

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

String name

The label provided when the consent recording was uploaded.

JsonValue; object_

constant

constant

The object type, which is always audio.voice_consent.

Retrieve voice consent

Java

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.audio.voiceconsents.VoiceConsent;
import com.openai.models.audio.voiceconsents.VoiceConsentRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        VoiceConsent voiceConsent = client.audio().voiceConsents().retrieve("consent_id");
    }
}

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"
}