VoxNeura/API Reference

VoxNeura API

The VoxNeura REST API lets you integrate AI text-to-speech directly into your applications. Generate lifelike speech with a single voice or multi-speaker conversations, manage voices, and track usage — all with a simple HTTP API.

Base URL: https://api.voxneura.com

Authentication

All API requests must include your API key in the X-API-Key header. You can create and manage your API keys from Settings → Developer.

Used for all "Try it out" panels below. Stored in session only.

bash
curl https://api.voxneura.com/api/v1/tts/generate \
  -H "X-API-Key: vn_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hello", "voice_id": "..." }'

Keep your key safe. API keys provide full access to your account quota. Never expose them in client-side code or public repositories. Revoke and rotate keys immediately if compromised.

Generation Parameters

Both generation endpoints accept an optional parameters object to fine-tune the output. All fields are optional — defaults are applied when omitted.

FieldTypeDefaultDescription
expressionfloat0.5Controls emotional expressiveness (0.0 – 2.0). Higher = more expressive.
consistencyfloat0.5Voice similarity to the reference (0.0 – 1.0). Higher = closer to the reference voice.
variationfloat0.8Output variability (0.05 – 5.0). Higher = more varied, less predictable output.
uniquenessfloat1.8Reduces repeated patterns (1.0 – 3.0). Higher values discourage repetition.
min_pfloat0.0Minimum token probability threshold (0.0 – 1.0).
top_pfloat1.0Nucleus sampling cutoff (0.0 – 1.0). Lower = more focused output.
speedfloat1.0Playback speed of the generated audio (0.5 – 2.0). Pitch is preserved.

Endpoints

Error Codes

All error responses return JSON with error: true and a message field describing the issue.

StatusMeaning
400Bad Request — invalid or missing parameters.
401Unauthorized — missing or invalid API key.
403Forbidden — quota exceeded or voice access denied.
404Not Found — the requested resource does not exist.
500Internal Server Error — something went wrong on our end.
json
{
  "error": true,
  "message": "insufficient characters — upgrade your plan or purchase more"
}