API keys & authentication
Drive every VocaSync service from your own code with a REST API and signed keys.
Creating an API key
Create and manage keys from Settings → API keys. Each key carries a name and a visible prefix (voca_ followed by the first characters) so you can tell keys apart at a glance.
Shown once
The full key is displayed only at creation. Copy and store it securely — you won’t be able to view it again, only rotate or revoke it.
Authenticating requests
Send your key with each API request to authenticate as your account. The exact header and request format for every endpoint — synthesis, alignment, transcription, translation, workflows, jobs, and projects — is documented in the API reference (an interactive OpenAPI explorer).
Rotation & expiry
- Create as many keys as you need — one per integration is good practice.
- Set an optional expiration date, and rotate a key at any time.
- Each key tracks its last-used time, and you’ll get a notification on key activity (configurable in notification preferences).
Idempotency & uploads
Submit an idempotency key with create requests to safely retry without creating duplicate jobs. For large media, request a presigned URL and upload bytes directly — see the API reference for the upload flow.
Related
- Webhooks — get notified when jobs and pipelines finish.
- Publishable keys — share artifacts publicly without exposing your API key.