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

With Design Your Own Avatar (DYOA), you can transform descriptive inputs—like appearance, outfit, and background—into personalized AI-generated avatars. Creatify’s API generates multiple photo options that you can review and submit for final approval.

​
⚙️ Quickstart Guide

​
✅ Prerequisites

Before you begin, ensure you have:

​
✏️ Step 1: Submit a DYOA Request

Use this endpoint to describe and generate your avatar: 
curl -X POST 
  --url https://api.creatify.ai/api/dyoa/ \
  -H "X-API-ID: <your-x-api-id>" \
  -H "X-API-KEY: <your-x-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "age_group": "young_adult",
    "gender": "m",
    "background_description": "Underwater reef, vibrant corals, schools of fish, shafts of light, drifting bubbles, seaweed swaying, hidden cave entrance.",
    "more_details": "Short dark blue hair, spiky texture, dark skin, brown eyes, muscular build, defined jawline, light freckles, full lips.",
    "outfit_description": "Leather bomber, high-neck tunic, silk wrap, spiked bracelets, satin gloves, gemstone collar, fur-trimmed shawl.",
    "name": "My Avatar"
  }'
💡 Initially, the photos array will be empty while your avatar is being generated.

​
📸 Step 2: Check If Photos Are Ready

Use this endpoint to fetch the current state of your avatar and generated photos: 
curl -X GET 
  --url https://api.creatify.ai/api/dyoa/{id}/ \
  -H "X-API-ID: <your-x-api-id>" \
  -H "X-API-KEY: <your-x-api-key>"
🖼️ Once the photos field is populated, you’ll be able to select one to submit for review.

​
🧾 Step 3: Submit a Photo for Review

After reviewing your generated options, select one photo to submit for approval: 
curl -X GET 
  --url https://api.creatify.ai/api/dyoa/{id}/submit_for_review/ \
  -H "X-API-ID: <your-x-api-id>" \
  -H "X-API-KEY: <your-x-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "chosen_photo_id": "a130d013-b194-4203-9b3f-40873f081b38"
  }'
🔄 The review status will appear in the reviews field and update as it progresses.

​
🔍 Step 4: Check Review Status

To check the outcome of your DYOA review:
  • When your avatar is under review: status will be "pending"
  • Once approved: status will be "done" and the avatar will be linked under creator
Use the same GET /api/dyoa/{id}/ endpoint to check for updates.

​
🤝 Need Help?

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