Create new avatar

There are three ways to make an avatar:

  1. Prompt: describe the avatar that you want.
  2. Profile: provide structured traits for the avatar.
  3. Image: use a reference image.

Each request creates a job. Poll the job until it completes. Then use the returned avatar handle or resource id to generate avatar videos.

The canonical Avatar 1.0 route is preferred:

Avatar creation uses a top-level avatar_handle and an input union. The handle can start with @. Sume normalizes the handle and stores it without @.

1. Prompt

Use this method when you want to create an avatar from text only.

Create an Avatar 1.0 identity

POST /v1/avatar-1.0/generate

Required

2. Profile

Use this method when your app already has profile details for the avatar. In the API, this method uses the props input type.

3. Image

Use this method when you have a reference image. In the API, this method uses the photo input type.

image_url must be a fetchable public HTTPS image URL. Before Sume submits the generation, it rejects localhost, private-network URLs, non-HTTPS URLs, and non-image responses. Refer to Media inputs.

Poll the job

When the job is completed, fetch the result.

Read avatar resources

The Avatar 1.0 resource routes are preferred:

Compatibility aliases

These older paths are still supported and use the same request body:

AliasNotes
POST /v1/models/sume/avatar-1.0/generate/runsCanonical model-run alias. For new integrations, /v1/avatar-1.0/generate is preferred.
POST /v1/models/sume/avatar/v1.0/runsLegacy launch alias.
GET /v1/avatars, GET /v1/avatars/:idCompatibility list/read routes. The response shape is the same as /v1/avatar-1.0/avatars.

Next

Use the returned avatar handle on Generate avatar video. For first-frame review before a full render, refer to Avatar video previews.