​
Introduction

Turn descriptions into a customized AI Avatar that fits your brand.

​
Quickstart

​
Prerequisite

  • You need a creatify.ai account with API access.
  • You need to go through the Get your API key

​
Create DYOA

import requests

url = "https://api.creatify.ai/api/dyoa/"

payload = {
    "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"
}

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

reponse: {
    "id": "63c44cd9-0340-44fa-8f1c-28043cc3203c",
    "user": 1,
    "workspace": "80654bb7-695f-43f5-bbaa-2da70f6e776a",
    "name": "My Avatar",
    "age_group": "young_adult",
    "gender": "m",
    "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.",
    "background_description": "Underwater reef, vibrant corals, schools of fish, shafts of light, drifting bubbles, seaweed swaying, hidden cave entrance.",
    "photos": [],
    "reviews": [],
    "status": "initializing",
    "created_at": "2025-01-09T12:26:10.074640-08:00",
    "updated_at": "2025-01-09T12:26:10.074692-08:00"
}

​
Check photos are generated

Now our AI model is generating the photos of DYOA for you to choose. You can check the photos generation by sending a GET request to Get DYOA item by id endpoint.

import requests

url = "https://api.creatify.ai/api/dyoa/{id}/"

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>"
}

response = requests.request("GET", url, headers=headers)

response: {
    "id": "63c44cd9-0340-44fa-8f1c-28043cc3203c",
    "user": 1,
    "workspace": "80654bb7-695f-43f5-bbaa-2da70f6e776a",
    "name": "My Avatar",
    "age_group": "young_adult",
    "gender": "m",
    "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.",
    "background_description": "Underwater reef, vibrant corals, schools of fish, shafts of light, drifting bubbles, seaweed swaying, hidden cave entrance.",
    "photos": [
        {
            "id": "a130d013-b194-4203-9b3f-40873f081b38",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/8bb9dcff.jpg",
            "created_at": "2025-01-09T12:27:00.240885-08:00"
        },
        {
            "id": "4ebebfd0-c75c-4621-b1c8-f8ae337f2c4b",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/6736a3b8.jpg",
            "created_at": "2025-01-09T12:27:00.223516-08:00"
        },
        {
            "id": "ad7daef8-91ad-4a78-899b-4d93fe2ffb2a",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/99a7089a.jpg",
            "created_at": "2025-01-09T12:27:00.206923-08:00"
        },
        {
            "id": "36090799-3c25-425a-b4dc-8a4892f04ff4",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/d56b684a.jpg",
            "created_at": "2025-01-09T12:27:00.188642-08:00"
        }
    ],
    "reviews": [],
    "status": "draft",
    "created_at": "2025-01-09T12:26:10.074640-08:00",
    "updated_at": "2025-01-09T12:26:10.074692-08:00"
}

The “photos” field in the response initially appears as an empty list. Once the photos are generated, it will be populated with the generated photos.

​
Choose a photo to submit for review

import requests

url = "https://api.creatify.ai/api/dyoa/{id}/submit_for_review/"

payload = {
    "chosen_photo_id": "a130d013-b194-4203-9b3f-40873f081b38"
}

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

response: {
    "id": "63c44cd9-0340-44fa-8f1c-28043cc3203c",
    "user": 1,
    "workspace": "80654bb7-695f-43f5-bbaa-2da70f6e776a",
    "name": "My Avatar",
    "age_group": "young_adult",
    "gender": "m",
    "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.",
    "background_description": "Underwater reef, vibrant corals, schools of fish, shafts of light, drifting bubbles, seaweed swaying, hidden cave entrance.",
    "photos": [
        {
            "id": "a130d013-b194-4203-9b3f-40873f081b38",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/8bb9dcff.jpg",
            "created_at": "2025-01-09T12:27:00.240885-08:00"
        },
        {
            "id": "4ebebfd0-c75c-4621-b1c8-f8ae337f2c4b",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/6736a3b8.jpg",
            "created_at": "2025-01-09T12:27:00.223516-08:00"
        },
        {
            "id": "ad7daef8-91ad-4a78-899b-4d93fe2ffb2a",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/99a7089a.jpg",
            "created_at": "2025-01-09T12:27:00.206923-08:00"
        },
        {
            "id": "36090799-3c25-425a-b4dc-8a4892f04ff4",
            "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/d56b684a.jpg",
            "created_at": "2025-01-09T12:27:00.188642-08:00"
        }
    ],
    "reviews": [
        {
            "id": "fd2a8aad-479f-4207-9b47-9b4983c961c0",
            "status": "pending",
            "comment": null,
            "photo": {
                "id": "a130d013-b194-4203-9b3f-40873f081b38",
                "image": "https://d35ghwdno3nak3.cloudfront.net/user/1/2025-01-09/8bb9dcff.jpg",
                "created_at": "2025-01-09T12:27:00.240885-08:00"
            },
            "creator": null,
            "social_link": null
        }
    ],
    "status": "pending",
    "created_at": "2025-01-09T12:26:10.074640-08:00",
    "updated_at": "2025-01-09T12:27:34.485921-08:00"
}

​
Check review status of DYOA

Your DYOA request is under review and processing. Once approved, the status field will update to “done”, and the creator field in the reviews will display the avatar associated with your request. You can check the review status by sending a GET request to Get DYOA item by id endpoint.

AI Editing APICreate video from link