Delete a voice consent recording | OpenAI API (unofficial showcase)

1 parameter

consent_idstringrequired

The identifier of the consent recording to delete.

3 status codes

200Returns the consent recording identifier, object type, and a `deleted` flag confirming deletion.

idstringrequired

The consent recording identifier.

objectstringrequired

Allowed:audio.voice_consent

deletedbooleanrequired

400Returned when the consent recording ID is invalid.

errorobjectrequired

404Returned when the endpoint is unavailable or the consent recording was not found.

errorobjectrequired

Error handling

A 400 is returned when consent_id is invalid. A 404 is returned when the endpoint is unavailable or the consent recording cannot be found.

import { Client } from "openai-api";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.voiceConsents.delete({ consentId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

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

Request

Response

Errors