Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.creatify.ai/llms.txt

Use this file to discover all available pages before exploring further.

🚀 Introduction

The Aurora API enables you to create studio-quality, avatar-based videos from just a single photo (real or AI-generated) and an audio clip (speech or song).
Powered by a state-of-the-art image-to-avatar model, Aurora generates lifelike videos where the avatar blinks, speaks, gestures, and emotes as if it were real.
Whether you’re building user-generated content (UGC) ads, animated characters, or singing avatars, Aurora delivers unparalleled realism with professional-grade output.

⚙️ Quickstart Guide

✅ Prerequisites

Before you begin, ensure you have:

📝 Step 1: Submit an Avatar Video Generation Request

Use this endpoint to generate a studio-grade avatar video from an image and an audio file.
curl --request POST \
    --url https://api.creatify.ai/api/aurora/ \
    --header 'Content-Type: application/json' \
    --header 'X-API-ID: your-api-id' \
    --header 'X-API-KEY: your-api-key' \
    --data '{
    "image": "https://d35ghwdno3nak3.cloudfront.net/tutorial/avatar-aurora/recommendation-4.jpg",
    "audio": "https://d35ghwdno3nak3.cloudfront.net/user/18165/2025-09-15/2d20-req-3VV9TLO6qlTOflMMQBRe-0-s.mp3",
    "model_version": "aurora_v1_fast",
    "webhook_url": "https://webhook.example"
  }'
🎬 The response includes a unique video ID. Save it to check status.

⏳ Step 2: Check Avatar Video Generation Status

You can monitor the video generation progress by polling the status endpoint using the returned ID until the status changes to done.
curl --request GET  \
   --url https://api.creatify.ai/api/aurora/44e480c0-642e-4057-9a50-de00a958e81c/ \
   --header 'X-API-ID: your-api-id' \
   --header 'X-API-KEY: your-api-key'
✅ When status is done, retrieve your video from the video_output field.

🔔 Webhook Option

Instead of polling, you can provide a webhook_url in the request to receive the result automatically when the video is ready.
When processing completes, Aurora will send a POST request to your webhook with a payload like this:
{
  "id": "76cdd8b1-e337-4fe3-925f-513f86047104",
  "status": "done",
  "failed_reason": "",
  "video_output": "https://s3.us-west-2.amazonaws.com/remotionlambda-uswest2-30tewi8y5c/renders/qpyttobqzy/output.mp4"
}

🎯 Summary

StepEndpoint
Create TaskPOST /api/aurora/
Check StatusGET /api/aurora/{id}/
API ReferenceAurora Reference

💳 Pricing

Creating a video through this endpoint costs 1 credit per second with aurora_v1, or 0.5 credits per second with aurora_v1_fast. Billing is per-second; partial seconds round up to the next whole second.

🤝 Need Help?

If you run into any issues, check out our API Reference or contact api@creatify.ai.