VoiceLabs
API ReferenceVoices and history

Get a generation

Look up a generation by id to poll its status (generating, completed, or failed). Returns 404 for an id that does not belong to this account. Requires the `voice:read` scope.

GET
/v1/generations/{generationId}

Look up a generation by id to poll its status (generating, completed, or failed). Returns 404 for an id that does not belong to this account.

Requires the voice:read 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

Path Parameters

generationId*string
Length1 <= length <= 200

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

curl -X GET "https://example.com/v1/generations/string"
{  "id": "string",  "status": "string",  "profile": "string",  "has_audio": true,  "audio_url": "string",  "error": "string"}

List captures GET

List this account's recent captures with their transcripts, most-recent first. Paginated with `limit` (1-200, default 50) and `offset`. Requires the `voice:read` scope.

Download generated audio GET

Download the audio of a completed generation. This URL is not called directly — it is the `audio_url` returned by GET /v1/generations/{generationId}, already signed and ready to follow. The signature grants access to this one generation for about 15 minutes, so no API key is sent (and none is accepted): the link can be handed straight to a media player, a download, or an <audio> tag that cannot attach an Authorization header. Links expire — poll the generation again to mint a fresh one rather than storing this URL. Authenticated by the signature in the URL, not by an API key.