Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Voice Designs API

Create and manage AI-generated voice designs using natural language prompts.

Telnyx Voice Designs API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Voice Designs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

7 operations 4 paths 10 schemas 2 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Voice Designs API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Voice Designs 7

Create and manage AI-generated voice designs using natural language prompts.

GET
/voice_designs
List voice designs
listVoiceDesigns 4 params → 200401
POST
/voice_designs
Create or add a version to a voice design
createVoiceDesign body → 201401404409422502
DELETE
/voice_designs/{id}
Delete a voice design
deleteVoiceDesign 1 param → 204401404
GET
/voice_designs/{id}
Get a voice design
getVoiceDesign 2 params → 200401404
PATCH
/voice_designs/{id}
Rename a voice design
updateVoiceDesign 1 param body → 200401404422
GET
/voice_designs/{id}/sample
Download voice design audio sample
getVoiceDesignSample 2 params → 200401404
DELETE
/voice_designs/{id}/versions/{version}
Delete a specific version of a voice design
deleteVoiceDesignVersion 2 params → 204400401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are VoiceDesignData (13 properties), VoiceDesignRequest (11 properties), VoiceDesignSummaryData (7 properties), voice-designs_ErrorObject (4 properties). Each schema is shown below with its type and property counts.

VoiceDesignData
object
A voice design object with full version detail.
13 properties
VoiceDesignResponse
object
Response envelope for a single voice design with full version detail.
1 property
VoiceDesignListResponse
object
Paginated list of voice designs.
2 properties
VoiceDesignSummaryData
object
A summarized voice design object (without version-specific fields).
7 properties
VoiceDesignUpdateRequest
object
Request body for renaming a voice design.
1 property 1 required
VoiceDesignRequest
object
Request body for creating a new voice design or adding a version to an existing one. Omit voicedesignid to create a new design; include it to add a new version.
11 properties 2 required
voice-designs_PaginationMeta
object
Pagination metadata returned with list responses.
4 properties
voice-designs_ErrorObject
object
A single error object.
4 properties
voice-designs_ErrorResponse
object
Standard error response envelope.
1 property
VoiceDesignUpdatedResponse
object
Response envelope for a voice design after a rename operation (no version-specific fields).
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-voice-designs-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API