Voice Consents

post /audio/voice_consents

Upload a voice consent recording.

Returns

id: string

The consent recording identifier.
created_at: number

The Unix timestamp (in seconds) for when the consent recording was created.
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.
- "audio.voice_consent"

Example

curl https://api.openai.com/v1/audio/voice_consents \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -F language=language \
    -F name=name \
    -F 'recording=@/path/to/recording'

Response

{
  "id": "cons_1234",
  "created_at": 0,
  "language": "language",
  "name": "name",
  "object": "audio.voice_consent"
}

Example

curl https://api.openai.com/v1/audio/voice_consents \
  -X POST \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -F "name=John Doe" \
  -F "language=en-US" \
  -F "recording=@$HOME/consent_recording.wav;type=audio/x-wav"

delete /audio/voice_consents/{consent_id}

Deletes a voice consent recording.

Path Parameters

consent_id: string

Returns

id: string

The consent recording identifier.
deleted: boolean
object: "audio.voice_consent"
- "audio.voice_consent"

Example

curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \
    -X DELETE \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "cons_1234",
  "deleted": true,
  "object": "audio.voice_consent"
}

Example

curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
  -X DELETE \
  -H "Authorization: Bearer $OPENAI_API_KEY"

List voice consents

get /audio/voice_consents

Returns a list of voice consent recordings.

Query Parameters

after: optional string

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 number

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

Returns

data: array of object { id, created_at, language, 2 more }
- id: string
  
  The consent recording identifier.
- created_at: number
  
  The Unix timestamp (in seconds) for when the consent recording was created.
- 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.
  - "audio.voice_consent"
has_more: boolean
object: "list"
- "list"
first_id: optional string
last_id: optional string

Example

curl https://api.openai.com/v1/audio/voice_consents \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

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

Example

curl https://api.openai.com/v1/audio/voice_consents?limit=20 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

get /audio/voice_consents/{consent_id}

Retrieves a voice consent recording.

Path Parameters

consent_id: string

Returns

id: string

The consent recording identifier.
created_at: number

The Unix timestamp (in seconds) for when the consent recording was created.
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.
- "audio.voice_consent"

Example

curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "cons_1234",
  "created_at": 0,
  "language": "language",
  "name": "name",
  "object": "audio.voice_consent"
}

Example

curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

post /audio/voice_consents/{consent_id}

Updates a voice consent recording (metadata only).

Path Parameters

consent_id: string

Body Parameters

name: string

The updated label for this consent recording.

Returns

id: string

The consent recording identifier.
created_at: number

The Unix timestamp (in seconds) for when the consent recording was created.
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.
- "audio.voice_consent"

Example

curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "name": "name"
        }'

Response

{
  "id": "cons_1234",
  "created_at": 0,
  "language": "language",
  "name": "name",
  "object": "audio.voice_consent"
}

Example

curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \
  -X POST \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe"
  }'

Domain Types

VoiceConsentCreateResponse object { 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: number
  
  The Unix timestamp (in seconds) for when the consent recording was created.
- 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.
  - "audio.voice_consent"

VoiceConsentDeleteResponse object { id, deleted, object }
- id: string
  
  The consent recording identifier.
- deleted: boolean
- object: "audio.voice_consent"
  - "audio.voice_consent"

VoiceConsentListResponse object { 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: number
  
  The Unix timestamp (in seconds) for when the consent recording was created.
- 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.
  - "audio.voice_consent"

VoiceConsentRetrieveResponse object { 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: number
  
  The Unix timestamp (in seconds) for when the consent recording was created.
- 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.
  - "audio.voice_consent"

VoiceConsentUpdateResponse object { 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: number
  
  The Unix timestamp (in seconds) for when the consent recording was created.
- 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.
  - "audio.voice_consent"

resources/audio/subresources/voice_consents/index.md +123 −123

1# Voice Consents1# Voice Consents

2 2

~~3## List voice consents~~3## Create voice consent

~~5**get** `/audio/voice_consents`~~

~~7Returns a list of voice consent recordings.~~

~~9### Query Parameters~~

~~11- `after: optional string`~~

13 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.

14 4

~~15- `limit: optional number`~~5**post** `/audio/voice_consents`

16 6

~~17 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.~~7Upload a voice consent recording.

18 8

19### Returns9### Returns

20 10

~~21- `data: array of object { id, created_at, language, 2 more }`~~11- `id: string`

~~23 - `id: string`~~

24 12

25 The consent recording identifier.13 The consent recording identifier.

26 14

~~27 - `created_at: number`~~15- `created_at: number`

28 16

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

30 18

~~31 - `language: string`~~19- `language: string`

32 20

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

34 22

~~35 - `name: string`~~23- `name: string`

36 24

37 The label provided when the consent recording was uploaded.25 The label provided when the consent recording was uploaded.

38 26

~~39 - `object: "audio.voice_consent"`~~27- `object: "audio.voice_consent"`

40 28

41 The object type, which is always `audio.voice_consent`.29 The object type, which is always `audio.voice_consent`.

42 30

43 - `"audio.voice_consent"`31 - `"audio.voice_consent"`

44 32

~~45- `has_more: boolean`~~33### Example

~~47- `object: "list"`~~

48 34

~~49 - `"list"`~~35```http

36curl https://api.openai.com/v1/audio/voice_consents \

37 -H 'Content-Type: multipart/form-data' \

38 -H "Authorization: Bearer $OPENAI_API_KEY" \

39 -F language=language \

40 -F name=name \

41 -F 'recording=@/path/to/recording'

42```

50 43

~~51- `first_id: optional string`~~44#### Response

52 45

~~53- `last_id: optional string`~~46```json

47{

48 "id": "cons_1234",

49 "created_at": 0,

50 "language": "language",

51 "name": "name",

52 "object": "audio.voice_consent"

53}

54```

54 55

55### Example56### Example

56 57

57```http58```http

58curl https://api.openai.com/v1/audio/voice_consents \59curl https://api.openai.com/v1/audio/voice_consents \

60 -X POST \

61 -H "Authorization: Bearer $OPENAI_API_KEY" \

62 -F "name=John Doe" \

63 -F "language=en-US" \

64 -F "recording=@$HOME/consent_recording.wav;type=audio/x-wav"

65```

67## Delete voice consent

69**delete** `/audio/voice_consents/{consent_id}`

71Deletes a voice consent recording.

73### Path Parameters

75- `consent_id: string`

77### Returns

79- `id: string`

81 The consent recording identifier.

83- `deleted: boolean`

85- `object: "audio.voice_consent"`

87 - `"audio.voice_consent"`

89### Example

91```http

92curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \

93 -X DELETE \

59 -H "Authorization: Bearer $OPENAI_API_KEY"94 -H "Authorization: Bearer $OPENAI_API_KEY"

60```95```

61 96

63 98

64```json99```json

65{100{

~~66 "data": [~~

~~67 {~~

68 "id": "cons_1234",101 "id": "cons_1234",

~~69 "created_at": 0,~~102 "deleted": true,

~~70 "language": "language",~~

~~71 "name": "name",~~

72 "object": "audio.voice_consent"103 "object": "audio.voice_consent"

~~73 }~~

~~74 ],~~

~~75 "has_more": true,~~

~~76 "object": "list",~~

~~77 "first_id": "first_id",~~

~~78 "last_id": "last_id"~~

79}104}

80```105```

81 106

82### Example107### Example

83 108

84```http109```http

~~85curl https://api.openai.com/v1/audio/voice_consents?limit=20 \~~110curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \

111 -X DELETE \

86 -H "Authorization: Bearer $OPENAI_API_KEY"112 -H "Authorization: Bearer $OPENAI_API_KEY"

87```113```

88 114

~~89## Create voice consent~~115## List voice consents

90 116

~~91**post** `/audio/voice_consents`~~117**get** `/audio/voice_consents`

92 118

~~93Upload a voice consent recording.~~119Returns a list of voice consent recordings.

120

121### Query Parameters

122

123- `after: optional string`

124

125 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.

126

127- `limit: optional number`

128

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

94 130

95### Returns131### Returns

96 132

~~97- `id: string`~~133- `data: array of object { id, created_at, language, 2 more }`

134

135 - `id: string`

98 136

99 The consent recording identifier.137 The consent recording identifier.

100 138

101- `created_at: number`139 - `created_at: number`

102 140

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

104 142

105- `language: string`143 - `language: string`

106 144

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

108 146

109- `name: string`147 - `name: string`

110 148

111 The label provided when the consent recording was uploaded.149 The label provided when the consent recording was uploaded.

112 150

113- `object: "audio.voice_consent"`151 - `object: "audio.voice_consent"`

114 152

115 The object type, which is always `audio.voice_consent`.153 The object type, which is always `audio.voice_consent`.

116 154

117 - `"audio.voice_consent"`155 - `"audio.voice_consent"`

118 156

157- `has_more: boolean`

158

159- `object: "list"`

160

161 - `"list"`

162

163- `first_id: optional string`

164

165- `last_id: optional string`

166

119### Example167### Example

120 168

121```http169```http

122curl https://api.openai.com/v1/audio/voice_consents \170curl https://api.openai.com/v1/audio/voice_consents \

123 -H 'Content-Type: multipart/form-data' \171 -H "Authorization: Bearer $OPENAI_API_KEY"

124 -H "Authorization: Bearer $OPENAI_API_KEY" \

125 -F language=language \

126 -F name=name \

127 -F 'recording=@/path/to/recording'

128```172```

129 173

130#### Response174#### Response

131 175

132```json176```json

133{177{

178 "data": [

179 {

134 "id": "cons_1234",180 "id": "cons_1234",

135 "created_at": 0,181 "created_at": 0,

136 "language": "language",182 "language": "language",

137 "name": "name",183 "name": "name",

138 "object": "audio.voice_consent"184 "object": "audio.voice_consent"

185 }

186 ],

187 "has_more": true,

188 "object": "list",

189 "first_id": "first_id",

190 "last_id": "last_id"

139}191}

140```192```

141 193

142### Example194### Example

143 195

144```http196```http

145curl https://api.openai.com/v1/audio/voice_consents \197curl https://api.openai.com/v1/audio/voice_consents?limit=20 \

146 -X POST \198 -H "Authorization: Bearer $OPENAI_API_KEY"

147 -H "Authorization: Bearer $OPENAI_API_KEY" \

148 -F "name=John Doe" \

149 -F "language=en-US" \

150 -F "recording=@$HOME/consent_recording.wav;type=audio/x-wav"

151```199```

152 200

153## Retrieve voice consent201## Retrieve voice consent

285 }'333 }'

286```334```

287 335

288## Delete voice consent

~~289~~

290**delete** `/audio/voice_consents/{consent_id}`

~~291~~

292Deletes a voice consent recording.

~~293~~

294### Path Parameters

~~295~~

296- `consent_id: string`

~~297~~

298### Returns

~~299~~

300- `id: string`

~~301~~

302 The consent recording identifier.

~~303~~

304- `deleted: boolean`

~~305~~

306- `object: "audio.voice_consent"`

~~307~~

308 - `"audio.voice_consent"`

~~309~~

310### Example

~~311~~

312```http

313curl https://api.openai.com/v1/audio/voice_consents/$CONSENT_ID \

314 -X DELETE \

315 -H "Authorization: Bearer $OPENAI_API_KEY"

316```

~~317~~

318#### Response

~~319~~

320```json

321{

322 "id": "cons_1234",

323 "deleted": true,

324 "object": "audio.voice_consent"

325}

326```

~~327~~

328### Example

~~329~~

330```http

331curl https://api.openai.com/v1/audio/voice_consents/cons_1234 \

332 -X DELETE \

333 -H "Authorization: Bearer $OPENAI_API_KEY"

334```

~~335~~

336## Domain Types336## Domain Types

337 337

338### Voice Consent List Response338### Voice Consent Create Response

339 339

340- `VoiceConsentListResponse object { id, created_at, language, 2 more }`340- `VoiceConsentCreateResponse object { id, created_at, language, 2 more }`

341 341

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

343 343

363 363

364 - `"audio.voice_consent"`364 - `"audio.voice_consent"`

365 365

366### Voice Consent Create Response366### Voice Consent Delete Response

367 367

368- `VoiceConsentCreateResponse object { id, created_at, language, 2 more }`368- `VoiceConsentDeleteResponse object { id, deleted, object }`

369

370 - `id: string`

371

372 The consent recording identifier.

373

374 - `deleted: boolean`

375

376 - `object: "audio.voice_consent"`

377

378 - `"audio.voice_consent"`

379

380### Voice Consent List Response

381

382- `VoiceConsentListResponse object { id, created_at, language, 2 more }`

369 383

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

371 385

446 The object type, which is always `audio.voice_consent`.460 The object type, which is always `audio.voice_consent`.

447 461

448 - `"audio.voice_consent"`462 - `"audio.voice_consent"`

~~449~~

450### Voice Consent Delete Response

~~451~~

452- `VoiceConsentDeleteResponse object { id, deleted, object }`

~~453~~

454 - `id: string`

~~455~~

456 The consent recording identifier.

~~457~~

458 - `deleted: boolean`

~~459~~

460 - `object: "audio.voice_consent"`

~~461~~

462 - `"audio.voice_consent"`

resources/audio/subresources/voice_consents/index.md 2026-07-25 05:59 UTC to 2026-07-29 15:02 UTC

Voice Consents

Create voice consent

Returns

Example

Response

Example

Delete voice consent

Path Parameters

Returns

Example

Response

Example

List voice consents

Query Parameters

Returns

Example

Response

Example

Retrieve voice consent

Path Parameters

Returns

Example

Response

Example

Update voice consent

Path Parameters

Body Parameters

Returns

Example

Response

Example

Domain Types

Voice Consent Create Response

Voice Consent Delete Response

Voice Consent List Response

Voice Consent Retrieve Response

Voice Consent Update Response