Generate AI Avatar Photo

Generate four photos based on the provided parameters

POST /photo_avatar/photo/generate

Generate Photo

cURL

curl --request POST \
  --url https://api.jogg.ai/v1/photo_avatar/photo/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "age": "Adult",
  "appearance": "<string>",
  "background": "<string>",
  "image_url": "<string>"
}
'

import requests

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

payload = {
    "age": "Adult",
    "appearance": "<string>",
    "background": "<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',
    appearance: '<string>',
    background: '<string>',
    image_url: '<string>'
  })
};

fetch('https://api.jogg.ai/v1/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/v1/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',
    'appearance' => '<string>',
    'background' => '<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/v1/photo_avatar/photo/generate"

	payload := strings.NewReader("{\n  \"age\": \"Adult\",\n  \"appearance\": \"<string>\",\n  \"background\": \"<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/v1/photo_avatar/photo/generate")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"age\": \"Adult\",\n  \"appearance\": \"<string>\",\n  \"background\": \"<string>\",\n  \"image_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v1/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  \"appearance\": \"<string>\",\n  \"background\": \"<string>\",\n  \"image_url\": \"<string>\"\n}"

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

200

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

{
  "code": 123,
  "msg": "<string>"
}

{
  "code": 123,
  "msg": "<string>"
}

Authorizations

x-api-key · string · header · required

Body

application/json

Request parameter

age · enum<string> · required

Available options: Teenager, Young adult, Adult, Elderly

Example:

"Adult"

aspect_ratio · enum<integer> · required

Photo aspect ratio:

• 0 - Portrait [9:16]
• 1 - Landscape [16:9]

Available options: 0, 1

avatar_style · enum<string> · required

Available options: Professional, Social

gender · enum<string> · required

Available options: Female, Male

model · enum<string> · required

Available options: classic, modern

appearance · string

background · string

ethnicity · enum<string>

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

image_url · string

Response

200

application/json

OK

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

msg · string · required

Response message

data · object

Show child attributes