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.

Update voice consent

client.Audio.VoiceConsents.Update(ctx, consentID, body) (*VoiceConsent, error)

POST

/audio/voice_consents/{consent_id}

Updates a voice consent recording (metadata only).

Parameters

consentID string

body AudioVoiceConsentUpdateParams

View schema details

Returns

type VoiceConsent struct{…}

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

ID string

The consent recording identifier.

CreatedAt int64

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 AudioVoiceConsent

The object type, which is always audio.voice_consent.

Update voice consent

Go

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  voiceConsent, err := client.Audio.VoiceConsents.Update(
    context.TODO(),
    "consent_id",
    openai.AudioVoiceConsentUpdateParams{
      Name: "name",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", voiceConsent.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"
}