Avatars

Generate a new avatar (async)

kind: "prompt" designs an AI avatar from a text description (no real person). kind: "photo" builds an avatar from a photo and requires consent: true plus a file_url or asset_id. Training runs in the background — poll GET /v1/avatars/{id}. Free accounts may create one avatar; more requires premium.

post/v1/avatars

Request

Base URL
https://api.vivideo.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/vivideo/apis/vivideo-api/docs/v1/avatars/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

kind'prompt' | 'photo' required

namestring required

promptstring

For kind=prompt.

file_urlstring

For kind=photo: https URL of the photo.

asset_idstring

Alternative to file_url: an uploaded asset id.

consentboolean

Required true for kind=photo.

reference_imagesstring[]

Response

Avatar creation started.

idstring

avatar_ref (av_...) for your avatars, or the catalogue avatar_id.

objectstring

namestring

kind'prompt' | 'photo'

statusstring

readyboolean

genderstring

preview_image_urlstring

preview_video_urlstring

looksobject[]

Example response

{
  "object": "avatar"
}

Changes

No recorded changes to this operation across all 1 revision of this API.