Create a 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>",
  "more_details": "<string>",
  "outfit_description": "<string>",
  "background_description": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "more_details": "<string>",
    "outfit_description": "<string>",
    "background_description": "<string>"
}
headers = {
    "X-API-ID": "<api-key>",
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-ID': '<api-key>',
    'X-API-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    more_details: '<string>',
    outfit_description: '<string>',
    background_description: '<string>'
  })
};

fetch('https://api.creatify.ai/api/dyoa/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.creatify.ai/api/dyoa/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'more_details' => '<string>',
    'outfit_description' => '<string>',
    'background_description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-ID: <api-key>",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"more_details\": \"<string>\",\n  \"outfit_description\": \"<string>\",\n  \"background_description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-ID", "<api-key>")
	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.creatify.ai/api/dyoa/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"more_details\": \"<string>\",\n  \"outfit_description\": \"<string>\",\n  \"background_description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.creatify.ai/api/dyoa/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"more_details\": \"<string>\",\n  \"outfit_description\": \"<string>\",\n  \"background_description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<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",
  "age_group": "infant",
  "gender": "m",
  "more_details": "<string>",
  "outfit_description": "<string>",
  "background_description": "<string>"
}

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>",
  "more_details": "<string>",
  "outfit_description": "<string>",
  "background_description": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "more_details": "<string>",
    "outfit_description": "<string>",
    "background_description": "<string>"
}
headers = {
    "X-API-ID": "<api-key>",
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-ID': '<api-key>',
    'X-API-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    more_details: '<string>',
    outfit_description: '<string>',
    background_description: '<string>'
  })
};

fetch('https://api.creatify.ai/api/dyoa/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.creatify.ai/api/dyoa/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'more_details' => '<string>',
    'outfit_description' => '<string>',
    'background_description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-ID: <api-key>",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"more_details\": \"<string>\",\n  \"outfit_description\": \"<string>\",\n  \"background_description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-ID", "<api-key>")
	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.creatify.ai/api/dyoa/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"more_details\": \"<string>\",\n  \"outfit_description\": \"<string>\",\n  \"background_description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.creatify.ai/api/dyoa/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"more_details\": \"<string>\",\n  \"outfit_description\": \"<string>\",\n  \"background_description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<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",
  "age_group": "infant",
  "gender": "m",
  "more_details": "<string>",
  "outfit_description": "<string>",
  "background_description": "<string>"
}

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

string<uuid>

required

read-only

user

integer | null

required

read-only

workspace

string<uuid> | null

required

read-only

name

string

required

The name of the avatar

Maximum string length: 255

photos

object[]

required

read-only

Show child attributes

reviews

object[]

required

read-only

Show child attributes

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

read-only

updated_at

string<date-time>

required

read-only

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

Get Started

URL to Video

Aurora

Boreal

Stock AI Avatar

Custom Avatar

Custom Template

Asset Generator

Ad Clone

Text to Speech

IAB Images

HTML Interactive Ad

Link Parser

AI Ad Script

Stock AI Voice

Stock AI Music

Workspace

AI Shorts (Deprecated)

AI Editing (Deprecated)

Product Video (Deprecated)

Authorizations

Body

Response