Add Motion to Photo Avatar

Add motion to a photo avatar to make it animated

POST /v2/photo_avatar/add_motion

Add Motion to Photo Avatar

cURL

curl --request POST \
  --url https://api.jogg.ai/v2/photo_avatar/add_motion \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "image_url": "https://res.jogg.ai/photo.jpg",
  "name": "My Photo Avatar",
  "voice_id": "en-US-ChristopherNeural",
  "model": "2.0",
  "photo_id": "<string>",
  "description": "<string>",
  "welcome_msg": "Hello, welcome!"
}
'

import requests

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

payload = {
    "image_url": "https://res.jogg.ai/photo.jpg",
    "name": "My Photo Avatar",
    "voice_id": "en-US-ChristopherNeural",
    "model": "2.0",
    "photo_id": "<string>",
    "description": "<string>",
    "welcome_msg": "Hello, welcome!"
}
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({
    image_url: 'https://res.jogg.ai/photo.jpg',
    name: 'My Photo Avatar',
    voice_id: 'en-US-ChristopherNeural',
    model: '2.0',
    photo_id: '<string>',
    description: '<string>',
    welcome_msg: 'Hello, welcome!'
  })
};

fetch('https://api.jogg.ai/v2/photo_avatar/add_motion', 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/add_motion",
  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([
    'image_url' => 'https://res.jogg.ai/photo.jpg',
    'name' => 'My Photo Avatar',
    'voice_id' => 'en-US-ChristopherNeural',
    'model' => '2.0',
    'photo_id' => '<string>',
    'description' => '<string>',
    'welcome_msg' => 'Hello, welcome!'
  ]),
  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/add_motion"

	payload := strings.NewReader("{\n  \"image_url\": \"https://res.jogg.ai/photo.jpg\",\n  \"name\": \"My Photo Avatar\",\n  \"voice_id\": \"en-US-ChristopherNeural\",\n  \"model\": \"2.0\",\n  \"photo_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"welcome_msg\": \"Hello, welcome!\"\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/add_motion")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image_url\": \"https://res.jogg.ai/photo.jpg\",\n  \"name\": \"My Photo Avatar\",\n  \"voice_id\": \"en-US-ChristopherNeural\",\n  \"model\": \"2.0\",\n  \"photo_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"welcome_msg\": \"Hello, welcome!\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"image_url\": \"https://res.jogg.ai/photo.jpg\",\n  \"name\": \"My Photo Avatar\",\n  \"voice_id\": \"en-US-ChristopherNeural\",\n  \"model\": \"2.0\",\n  \"photo_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"welcome_msg\": \"Hello, welcome!\"\n}"

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

200

{
  "rid": "7abb75ebf2523038874d66cf5dfb2b02",
  "code": 0,
  "msg": "success",
  "data": {
    "avatar_id": 123,
    "motion_id": "motion_456",
    "status": "processing"
  }
}

Add motion to a photo avatar to make it animated.

Example Usage

curl --request POST \
  --url 'https://api.jogg.ai/v2/photo_avatar/add_motion' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "image_url": "https://res.jogg.ai/photo.jpg",
    "name": "My Photo Avatar",
    "voice_id": "en-US-ChristopherNeural",
    "model": "2.0"
  }'

Related Guides

Generate Photo Avatar

Generate photo avatar first

Check Motion Status

Check motion generation status

Authorizations

x-api-key · string · header · required

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

Body

application/json

image_url · string<uri> · required

Photo avatar image URL

Example:

"https://res.jogg.ai/photo.jpg"

name · string · required

Avatar name

Example:

"My Photo Avatar"

voice_id · string · required

Voice ID to associate with avatar

Example:

"en-US-ChristopherNeural"

model · enum<string> · required

Motion model version

Available options: 1.0, 2.0, 2.0-Pro, 3.0

Example:

"2.0"

photo_id · string

Photo ID from photo generation

description · string

Avatar description

welcome_msg · string

Welcome message for the avatar

Example:

"Hello, welcome!"

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