{ "opencollection": "1.0.0", "info": { "name": "Telnyx Access Tokens Voice Designs API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Voice Designs", "type": "folder" }, "items": [ { "info": { "name": "List voice designs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_designs", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number for pagination (1-based)." }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of results per page." }, { "name": "filter[name]", "value": "", "type": "query", "description": "Case-insensitive substring filter on the name field." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order. Prefix with `-` for descending. Defaults to `-created_at`." } ] }, "docs": "Returns a paginated list of voice designs belonging to the authenticated account." }, { "info": { "name": "Create or add a version to a voice design", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/voice_designs", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new voice design (version 1) when `voice_design_id` is omitted. When `voice_design_id` is provided, adds a new version to the existing design instead. A design can have at most 50 versions." }, { "info": { "name": "Get a voice design", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." }, { "name": "version", "value": "", "type": "query", "description": "Specific version number to retrieve. Defaults to the latest version." } ] }, "docs": "Returns the latest version of a voice design, or a specific version when `?version=N` is provided. The `id` parameter accepts either a UUID or the design name." }, { "info": { "name": "Rename a voice design", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/voice_designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name of a voice design. All versions retain their other properties." }, { "info": { "name": "Delete a voice design", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/voice_designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." } ] }, "docs": "Permanently deletes a voice design and all of its versions. This action cannot be undone." }, { "info": { "name": "Download voice design audio sample", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_designs/:id/sample", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." }, { "name": "version", "value": "", "type": "query", "description": "Specific version number to download the sample for. Defaults to the latest version." } ] }, "docs": "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." }, { "info": { "name": "Delete a specific version of a voice design", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/voice_designs/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." }, { "name": "version", "value": "", "type": "path", "description": "The version number to delete." } ] }, "docs": "Permanently deletes a specific version of a voice design. The version number must be a positive integer." } ] } ], "bundled": true }