List voice consent recordings | OpenAI API (unofficial showcase)

2 parameters

afterstringoptional

Cursor identifying a position in the list; use an object ID from a previous response to retrieve the next page.

limitintegeroptional

Maximum number of voice consent recordings to return, from 1 to 100. Defaults to 20 when omitted.

Default:20

3 status codes

200Returns a list of voice consent recording objects, pagination cursors, and a `has_more` indicator.

objectstringrequired

Allowed:list

dataarray<VoiceConsent>required

first_idstringoptional

last_idstringoptional

has_morebooleanrequired

400Returned when pagination parameters are invalid.

errorobjectrequired

404Returned when the endpoint is unavailable or the pagination cursor is not found.

errorobjectrequired

Error handling

A 400 is returned when pagination parameters are invalid, and a 404 is returned when the endpoint is unavailable or the cursor is not found. limit must be between 1 and 100; use an after cursor from the list to continue pagination.

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.list({
  after: "example",
  limit: 20,
});

{
  "object": "list",
  "data": [
    {
      "object": "audio.voice_consent",
      "id": "cons_1234",
      "name": "Example Name",
      "language": "example_value",
      "created_at": 1
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response

Errors