Models

Choose a model based on the experience you want to build.

A-series — for realtime avatar experiences and avatar video generation.
W-series — for continuous realtime worlds and reference-guided world video generation.

Pass one of the supported model IDs below in the model field. Refer to the linked API guide for endpoint-specific requirements. To discover which models are enabled for your API key, call GET /v1/models.

Model overview

Model	What it does	Docs
`vivix-a1-stream` `vivix-a1-stream-lite`	Realtime avatar sessions	Streaming Avatar
`vivix-a1`	Avatar videos driven by script, audio and images	Avatar Video Generation
`vivix-w1-stream`	Continuous realtime world sessions steered by open-ended Events	Streaming World
`vivix-w1`	Reference-driven world video generation	World Video Generation

List Models

Returns the models enabled for your API key. Use this to discover which name values you can pass as model on Streaming Avatar and Avatar Video Generation requests. The list is scoped to your workspace: you only see models that are currently enabled for your key. Each item is the current primary version of that model. Pinned minor versions are not listed.

Response envelope. REST responses are wrapped in {code, message, data}: code = 0 means success. Field descriptions below refer to fields inside data.

GET /v1/models

Response Fields

array

Models available to the current API key. An empty list means none are enabled for this key.

Show properties

string

Public model ID. Pass this as the model field on later requests.

optional string

Optional version tag. Omitted for the default / latest version.

Error Cases

Condition	API error code
The API key is missing or invalid.	`10001 missing api key` or `10003 invalid api key`
The request exceeded the API key rate limit (HTTP 429; 60 requests/min per key by default; the response includes a Retry-After header).	`10008 API rate limit exceeded`

Request

curl https://api.vivix.ai/v1/models \
  -H "Authorization: Bearer $VIVIX_API_KEY"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "models": [
      {
        "name": "vivix-a1"
      },
      {
        "name": "vivix-a1-stream"
      },
      {
        "name": "vivix-a1-stream-lite"
      }
    ]
  }
}

Overview

A1: Streaming Avatar

W1: Streaming World

Blazing Fast Video Generation

Model overview

List Models

Response Fields

Error Cases

​Model overview

​List Models

​Response Fields

​Error Cases

Model overview

List Models

Response Fields

Error Cases