VoiceLabs
API ReferenceGeneration

Create speech

Generate speech from text in one of this account's voice profiles. Returns immediately with a generation id and status "generating" — poll GET /v1/generations/{id} to retrieve the audio URL once it completes. Send an Idempotency-Key header to make a retried request safe: the same key with the same body replays the original response instead of generating a second time. Requires the `voice:generate` scope.

POST
/v1/speech

Generate speech from text in one of this account's voice profiles. Returns immediately with a generation id and status "generating" — poll GET /v1/generations/{id} to retrieve the audio URL once it completes. Send an Idempotency-Key header to make a retried request safe: the same key with the same body replays the original response instead of generating a second time.

Requires the voice:generate scope.

Authorization

x-api-key<token>

A VoiceLabs API key, sent in the x-api-key header. Keys begin with vl_sandbox_. This is the simplest way to authenticate and is what most callers should use.

Create one in the developer console at https://voicelabs.now/connections, on the API keys tab, choosing the scopes it carries. A key does exactly what its scopes allow: one without voice:generate is answered 403 insufficient_scope on the generation operations and cannot spend the account's allowance. The secret is shown once, at creation; revoking a key takes effect on its very next request.

In: header

Header Parameters

Idempotency-Key?string

An optional client-generated key that makes a retry safe. Replaying the same key with the same body returns the ORIGINAL response byte-for-byte instead of doing the work a second time; replaying it with a different body is refused with idempotency_key_reused.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/speech" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "id": "string",  "status": "string",  "voice": "string"}

API Reference

The VoiceLabs /v1 REST API, operation by operation — generated from the published OpenAPI 3.1 document, with a request builder on every page.

Create a transcription POST

Transcribe a base64-encoded audio clip to text. Returns the transcript along with the id of the capture it created, which stays retrievable through GET /v1/captures. Send an Idempotency-Key header to make a retried request safe. Requires the `voice:generate` scope.