Generate Photo Avatar

Generate AI photo avatar based on provided parameters

POST /v2/photo_avatar/photo/generate

Generate Photo Avatar

cURL

curl --request POST \
  --url https://api.jogg.ai/v2/photo_avatar/photo/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "age": "Adult",
  "avatar_style": "Professional",
  "gender": "Female",
  "model": "modern",
  "aspect_ratio": "portrait",
  "background": "<string>",
  "appearance": "<string>",
  "image_url": "<string>"
}
'

import requests

url = "https://api.jogg.ai/v2/photo_avatar/photo/generate"

payload = {
    "age": "Adult",
    "avatar_style": "Professional",
    "gender": "Female",
    "model": "modern",
    "aspect_ratio": "portrait",
    "background": "<string>",
    "appearance": "<string>",
    "image_url": "<string>"
}
headers = {
    "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-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    age: 'Adult',
    avatar_style: 'Professional',
    gender: 'Female',
    model: 'modern',
    aspect_ratio: 'portrait',
    background: '<string>',
    appearance: '<string>',
    image_url: '<string>'
  })
};

fetch('https://api.jogg.ai/v2/photo_avatar/photo/generate', 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.jogg.ai/v2/photo_avatar/photo/generate",
  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([
    'age' => 'Adult',
    'avatar_style' => 'Professional',
    'gender' => 'Female',
    'model' => 'modern',
    'aspect_ratio' => 'portrait',
    'background' => '<string>',
    'appearance' => '<string>',
    'image_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.jogg.ai/v2/photo_avatar/photo/generate"

	payload := strings.NewReader("{\n  \"age\": \"Adult\",\n  \"avatar_style\": \"Professional\",\n  \"gender\": \"Female\",\n  \"model\": \"modern\",\n  \"aspect_ratio\": \"portrait\",\n  \"background\": \"<string>\",\n  \"appearance\": \"<string>\",\n  \"image_url\": \"<string>\"\n}")

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

	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.jogg.ai/v2/photo_avatar/photo/generate")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"age\": \"Adult\",\n  \"avatar_style\": \"Professional\",\n  \"gender\": \"Female\",\n  \"model\": \"modern\",\n  \"aspect_ratio\": \"portrait\",\n  \"background\": \"<string>\",\n  \"appearance\": \"<string>\",\n  \"image_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/photo_avatar/photo/generate")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"age\": \"Adult\",\n  \"avatar_style\": \"Professional\",\n  \"gender\": \"Female\",\n  \"model\": \"modern\",\n  \"aspect_ratio\": \"portrait\",\n  \"background\": \"<string>\",\n  \"appearance\": \"<string>\",\n  \"image_url\": \"<string>\"\n}"

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

200

{
  "code": 0,
  "msg": "Success",
  "data": {
    "photo_id": "<string>"
  }
}

Generate a custom AI avatar from a photo. Upload a portrait photo to create a talking avatar.

Example Usage

curl -X POST 'https://api.jogg.ai/v2/photo_avatar/photo/generate' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "photo_url": "https://example.com/portrait.jpg",
    "name": "John Doe Avatar"
  }'

Related Guides

Create Photo Avatar Guide

Complete photo avatar workflow

Authorizations

x-api-key · string · header · required

API key for authentication. Obtain your key from the JoggAI dashboard.

Body

application/json

age · enum<string> · required

Avatar age group

Available options: Teenager, Young adult, Adult, Elderly

Example:

"Adult"

avatar_style · enum<string> · required

Avatar style category

Available options: Professional, Social

Example:

"Professional"

gender · enum<string> · required

Avatar gender

Available options: Female, Male

Example:

"Female"

model · enum<string> · required

Photo generation model style

Available options: classic, modern

Example:

"modern"

aspect_ratio · enum<string> · required

Photo aspect ratio

Available options: portrait, landscape, square

Example:

"portrait"

ethnicity · enum<string>

Avatar ethnicity

Available options: European, African, South Asian, East Asian, Middle Eastern, South American, North American

background · string

Background description

appearance · string

Appearance description

image_url · string

Reference image URL

Response

200 - application/json

Success

code · integer · required

Business status code:

• 0 - Success
• 10104 - Record not found
• 10105 - Invalid API key
• 18020 - Insufficient credit
• 18025 - No permission to call APIs
• 40000 - Parameter error
• 50000 - System error

Example:

0

msg · string · required

Response message

Example:

"Success"

data · object

Show child attributes