Skip to main content
POST
/
api
/
dyoa
/
cURL
curl --request POST \
  --url https://api.creatify.ai/api/dyoa/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "age_group": "infant",
  "gender": "m",
  "more_details": "<string>",
  "outfit_description": "<string>",
  "background_description": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "age_group": "infant",
  "gender": "m",
  "more_details": "<string>",
  "outfit_description": "<string>",
  "background_description": "<string>",
  "photos": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "image": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "reviews": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "comment": "<string>",
      "photo": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "image": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "creator": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "squared_preview_video": "<string>",
        "squared_preview_image": "<string>",
        "portrait_preview_video": "<string>",
        "landscape_preview_image": "<string>",
        "landscape_preview_video": "<string>",
        "landscape_lipsync_video": "<string>",
        "portrait_preview_image": "<string>",
        "portrait_lipsync_video": "<string>"
      },
      "social_link": "<string>"
    }
  ],
  "status": "initializing",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Body

​
name
string
required

The name of the fully synthetic avatar.

​
age_group
enum<string>
required

The age group of the avatar.

  • infant - infant
  • child - child
  • teen - teen
  • young_adult - young_adult
  • early_middle_age - early_middle_age
  • late_middle_age - late_middle_age
  • senior - senior
Available options:
infant,
child,
teen,
young_adult,
early_middle_age,
late_middle_age,
senior
​
gender
enum<string>
required

The gender of the avatar.

  • m - m
  • f - f
  • nb - nb
Available options:
m,
f,
nb
​
more_details
string
required

Additional details about the avatar.

​
outfit_description
string
required

Description of the outfit of the avatar.

​
background_description
string
required

Description of the background of the avatar.

Response

201 - application/json
​
id
string<uuid>
required
​
user
integer | null
required
​
workspace
string<uuid> | null
required
​
name
string
required

The name of the avatar

Maximum length: 255
​
photos
object[]
required
​
reviews
object[]
required
​
status
enum<string>
required

The status of the avatar

  • initializing - Initializing
  • draft - Draft
  • pending - Pending
  • in_progress - In Progress
  • done - Done
  • rejected - Rejected
Available options:
initializing,
draft,
pending,
in_progress,
done,
rejected
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
age_group

Age Group

  • infant - 0 to 5 years old
  • child - 5 to 12 years old
  • teen - 13 to 19 years old
  • young_adult - 20 to 34 years old
  • early_middle_age - 35 to 44 years old
  • late_middle_age - 45 to 54 years old
  • senior - 55 years old and above
Available options:
infant,
child,
teen,
young_adult,
early_middle_age,
late_middle_age,
senior
​
gender

Gender

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
​
more_details
string | null

More Details of avatar

​
outfit_description
string | null

Description of the avatar's outfit

​
background_description
string | null

Description of the avatar's background