VocenzaDocs

API Reference

REST and websocket endpoints, request/response shapes, and conventions.

The Vocenza API is organized around predictable, resource-oriented endpoints. All REST requests go to https://api.vocenza.com/v1 and authenticate with a Bearer key (see Authentication).

Base URL

https://api.vocenza.com/v1

Endpoints

MethodPathDescription
POST/speechSynthesize speech from text.
POST/transcriptionsTranscribe an audio file.
GET/voicesList available voices.
WS/realtimeOpen a realtime conversation.

Conventions

  • Auth — Authorization: Bearer voc_… on every request.
  • Content type — application/json for JSON bodies; multipart/form-data for file uploads; binary for audio responses.
  • Errors — consistent JSON shape with error.type and error.message. See Errors.
  • Idempotency — pass an Idempotency-Key header on POST requests to make retries safe.

Versioning

The API is versioned in the path (/v1). Breaking changes ship under a new version; additive changes may appear within /v1 without notice.