Generate Avatar Images

Generate new images to an existing avatar profile with the given avatar_id using AI.

Inputs

POSThttps://api.zoice.com/v1/avatar-profiles/{avatar_id}/images/generate
path
string
required
body
string
optional
body
string
optional
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
required
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
string
optional
body
string
optional
body
integer
optional
idle

Using the Endpoint

You can add new AI-generated avatar images to an existing avatar profile with the given avatar_id by sending a POST request to /v1/avatar-profiles/{avatar_id}/images/generate endpoint.

POSThttps://api.zoice.com/v1/avatar-profiles/{avatar_id}/images/generate

Replace the avatar_id in the path with the actual value and the body of the request can include the following fields:

  • model: Optional field to select the AI model you would like to use for generation like google/nano-banana-2.
  • base_image_id: Optional field to set which existing avatar image you would like to use as base reference to the new image. If undefined or null, the default base_image_id value of the avatar profile is used.
  • reference_image_urls: Optional array of additional image references you can use for the new avatar image generation. This can be helpful if you would like to add props to your avatar.
  • image_prompt: Text prompt to guide the new image generation. This is a required field.
  • aspect_ratio: Optional field to set the aspect ratio; default value is 16:9.
  • resolution: Optional field to set the resolution; default value is 2k.
  • num_images: Optional field to indicate the number of images you would like to generate. The possible values depend on the model you have selected.

Visit Generate Avatar Images API documentation to see examples and also learn more about the fields, request and response structure, and schemas.