List avatar models — VisionStory API

List the avatar rendering models available for talking-avatar videos. Each entry reports its supported aspect ratios and resolutions and its maximum clip duration. Pass a model's model_id to POST /api/v1/video.

Headers

X-API-Keystringrequired

Your VisionStory API key (sk-vs-...), kept server-side. Create or manage keys in API keys (Pro plan and up).

Responses

200Successful Response

application/json

dataGetModelsResponse | nullrequirednullable

The endpoint payload. Its shape is specific to each endpoint (see that endpoint's response schema); null for operations that return no body, such as delete.

modelsModelDto[]required

Available avatar rendering models with their supported options.

aspect_ratiosstring[]

Aspect ratios this model can render; pass one of these as aspect_ratio when creating a video.

descriptionstringrequired

Human-readable summary of the model's strengths and intended use.

max_duration_secondsintegerrequired

Maximum length, in seconds, of a video this model can generate in one request.

model_idstringrequired

Stable model identifier. Pass it as model_id when creating a video, e.g. vs_talk_v1 or vs_character_v4.

resolutionsstring[]

Output resolutions this model supports; pass one of these as resolution. Higher resolutions cost more credits and take longer to render.

messagestring

Human-readable status message; "success" on a successful call.

Default: success

server_timestring · date-timerequired

Server-side timestamp when the response was produced, in ISO 8601 format (UTC).

defaultError response. All failures share one 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 (useful for AI agents).

application/json

errorErrorDetailrequired

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.

detailsstring | nullnullable

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 | nullnullable

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.

messagestringrequired

Human-readable explanation of what went wrong. Safe to log or surface to end users; not localized.