Download voice design audio sample

Downloads the WAV audio sample for the voice design. Returns the latest version’s sample by default, or a specific version when ?version=N is provided. The id parameter accepts either a UUID or the design name.

GET /voice_designs/{id}/sample

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.voiceDesigns.downloadSample('id');

console.log(response);

const content = await response.blob();
console.log(content);

200

"<string>"

Path Parameters

id · string · required

The voice design UUID or name.

Query Parameters

version · integer

Specific version number to download the sample for. Defaults to the latest version.

Required range: x >= 1

Response

200

audio/wav

WAV audio sample binary.

The response is of type file.