List avatars — VisionStory API

List avatars available to your account: the public platform library plus your own custom avatars (up to 100). The response is not paginated.

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

dataGetAvatarsResponse | 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.

my_avatarsAvatarDto[]required

Custom avatars created by this account (up to 100 returned).

aspect_ratiosstring[]

Aspect ratios this avatar was prepared for (1:1 / 9:16 / 16:9). Choose a matching aspect_ratio when generating a video.

avatar_idstringrequired

Unique avatar identifier. Pass it as avatar_id when generating a talking video.

created_atinteger

Unix timestamp (seconds) when the avatar was created; 0 for public/platform avatars.

Default: 0

thumbnail_urlstringrequired

URL of the avatar's preview thumbnail image.

public_avatarsAvatarDto[]required

Platform-provided avatars available to every account.

aspect_ratiosstring[]

Aspect ratios this avatar was prepared for (1:1 / 9:16 / 16:9). Choose a matching aspect_ratio when generating a video.

avatar_idstringrequired

Unique avatar identifier. Pass it as avatar_id when generating a talking video.

created_atinteger

Unix timestamp (seconds) when the avatar was created; 0 for public/platform avatars.

Default: 0

thumbnail_urlstringrequired

URL of the avatar's preview thumbnail image.

total_cntintegerrequired

Total number of avatars returned across both lists.

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.