Create Avatar Profile

Create a new avatar profile with a prompt text or an input image.

Inputs

POSThttps://api.zoice.com/v1/avatar-profiles
body
string
required
body
string
optional
Use base_image_prompt field if you would like to use AI to generate avatar base image. Alternatively, you can switch to base_image_url to upload base image directly.
body
array
optional

Drag and drop image or add an image url.

Use reference_image_urls in combination with base_image_prompt to assist AI base image generation.
body
string
optional
body
string
optional
body
string
optional
body
string
optional
idle

Using the Endpoint

This endpoint can be used to create a new avatar profile based on a prompt text or an input image and are useful for maintaining character consistency across avatar videos.

POSThttps://api.zoice.com/v1/avatar-profiles

To generate a new avatar profile, send a POST request to /v1/avatar-profiles helper endpoint with the body of the request containing the following parameters:

  • avatar_name: The name of the avatar character. This is a required field.
  • base_image_prompt: A text prompt to guide the generation of the avatar profile.
  • reference_image_urls: An optional array of image URLs to be used as reference for generating base image. This is to be used in combination with base_image_prompt.
  • base_image_url: Alternative to base_image_prompt; add an image url directly to be used as base image for the avatar profile.
  • gender: An optional field to indicate the gender of the avatar profile and the possible values include "male", "female" and "other".
  • age: An optional field to indicate the age of the avatar profile and the possible values are "child", "teen", "young-adult", "early-middle-aged", "late-middle-aged", and "senior".
  • ethnicity: An optional field to indicate the ethnicity of the avatar profile and the possible values include "white", "black", "east-asian", "southeast-asian", "south-asian", "middle-eastern", "pacific-islander", "hispanic-or-latino".
  • description: An optional description field for the avatar.