VisionStory Docs
llms.txt Get API key
Voices/List voices
GET/api/v1/voices

List the voices you can synthesize with: the public voice library plus any voices you have cloned.

Headers

X-API-KeystringRequired
Your VisionStory API key (sk-vs-...), kept server-side. Create one at OpenApi (Pro plan and up).

Response

200Successful Response

Successful calls return a standard envelope: the endpoint payload under data (its fields are documented below), plus a message string ("success") and an ISO 8601 server_time.

Response fields (data)
public_voicesarray of VoiceDtoRequired
Platform-provided voices available for text-to-speech.
Show 6 propertiesHide 6 properties
voice_idstringRequired
Voice identifier. Pass it as voice_id in a text script, or as the target voice when converting uploaded audio.
is_freebooleanRequired
Whether this voice is usable on the free plan; premium voices require a paid plan.
preview_audio_urlstringRequired
URL of a short sample clip demonstrating how this voice sounds.
tagsstring | nullOptional
Free-text descriptors (e.g. accent, gender, age) to help pick a voice; may be empty.
languagestringRequired
Primary language this voice speaks, e.g. english.
providerstringOptionalDefault ""
Speech engine this voice comes from (e.g. elevenlabs / gemini / minimax), so you can pick voices by engine. Descriptive, not a guarantee: synthesis may fall back to another engine.
my_voicesarray of VoiceDtoRequired
Voices this account has cloned.
Show 6 propertiesHide 6 properties
voice_idstringRequired
Voice identifier. Pass it as voice_id in a text script, or as the target voice when converting uploaded audio.
is_freebooleanRequired
Whether this voice is usable on the free plan; premium voices require a paid plan.
preview_audio_urlstringRequired
URL of a short sample clip demonstrating how this voice sounds.
tagsstring | nullOptional
Free-text descriptors (e.g. accent, gender, age) to help pick a voice; may be empty.
languagestringRequired
Primary language this voice speaks, e.g. english.
providerstringOptionalDefault ""
Speech engine this voice comes from (e.g. elevenlabs / gemini / minimax), so you can pick voices by engine. Descriptive, not a guarantee: synthesis may fall back to another engine.

Errors

All error responses share one JSON envelope: an error object with a numeric code, a human-readable message, an optional details string, and an optional hint giving an actionable next step (handy for AI agents).

errorErrorDetailRequired
Error payload returned with every non-2xx response. Present only on failure; successful calls use the standard success envelope instead.
Show 4 propertiesHide 4 properties
codeintegerRequired
Machine-readable error code. Mirrors the HTTP status for transport-level failures (e.g. 401, 404, 422, 500) and may carry a business-specific code otherwise.
messagestringRequired
Human-readable explanation of what went wrong. Safe to log or surface to end users; not localized.
detailsstring | nullOptional
Optional structured detail about the failure, e.g. a JSON string of per-field validation errors on a 422. Absent when there is nothing extra to report.
hintstring | nullOptional
Actionable next step for resolving the error, written for both humans and AI agents (e.g. how to fix the request, or where to obtain an API key). May be absent.