zoice/avatar-edit

Zoice Avatar Edit API Docs

Zoice Avatar Edit API endpoint generates ultra-realistic images to be added to your selected avatar. Besides a base image and a prompt, you can also optionally add multiple reference images, aspect ratio and resolution option to ensure the AI generates the desired image for your avatar.

API Request

The API endpoint handles heavy media rendering tasks asynchronously using a fast queue-based system, and the request immediately returns a request_id. Use the request_id to poll the status of the generation and return the result after the task is completed.

Sending Request

curl -X POST "https://api.zoice.com/v1/run/zoice/avatar-edit" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ZOICE_API_KEY" \
  -d '{
    "avatar_id": "ad4ed5d7-22eb-...",
    "base_image_url": "https://storage.zoice.com/......png",
    "reference_image_urls": [
      "https://storage.zoice.com/......png"
    ],
    "image_prompt": "Make the avatar look happy.",
    "aspect_ratio": "9:16",
    "resolution": "1k"
  }'

Response Format

{
  "request_id": 'd1f47b9c-6387-49d0-a403-...',
  "status": 'processing',
}

Polling and Output

After submitting an asynchronous API request, you can use the request_id obtained from the response to further poll for the status of the generation and ultimately retrieve the result after the completion. Use the /v1/fetch/request_id endpoint to perform this operation.

Polling Request

curl -X GET "https://api.zoice.com/v1/fetch/{request_id}" \
  -H "Authorization: Bearer $ZOICE_API_KEY"

Polling Response

{
  "status": 'success',
  "request_id": 'd1f47b9c-6387-49d0-a403-...',
  "type": "image",
  "output": {
	"credits": 20,
    "result": "https://storage.zoice.com/...png"
  }
}

Schema

Input

Output