Add Motion

Adds an motion for the specified Photo Avatar

POST /photo_avatar/add_motion

Add motion

cURL

curl --request POST \
  --url https://api.jogg.ai/v1/photo_avatar/add_motion \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "image_url": "<string>",
  "name": "<string>",
  "voice_id": "<string>",
  "description": "<string>",
  "photo_id": "<string>",
  "welcome_msg": "<string>"
}
'

import requests

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

payload = {
    "image_url": "<string>",
    "name": "<string>",
    "voice_id": "<string>",
    "description": "<string>",
    "photo_id": "<string>",
    "welcome_msg": "<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({
    image_url: '<string>',
    name: '<string>',
    voice_id: '<string>',
    description: '<string>',
    photo_id: '<string>',
    welcome_msg: '<string>'
  })
};

fetch('https://api.jogg.ai/v1/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/v1/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' => '<string>',
    'name' => '<string>',
    'voice_id' => '<string>',
    'description' => '<string>',
    'photo_id' => '<string>',
    'welcome_msg' => '<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/add_motion"

	payload := strings.NewReader("{\n  \"image_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"photo_id\": \"<string>\",\n  \"welcome_msg\": \"<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/add_motion")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"photo_id\": \"<string>\",\n  \"welcome_msg\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v1/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\": \"<string>\",\n  \"name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"photo_id\": \"<string>\",\n  \"welcome_msg\": \"<string>\"\n}"

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

200

{
  "code": 123,
  "msg": "<string>",
  "data": {
    "avatar_id": 123,
    "motion_id": "<string>",
    "name": "<string>"
  }
}

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

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

Authorizations

x-api-key · string · header · required

Body

application/json

Request parameter

image_url · string · required

model · enum<string> · required

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

name · string · required

voice_id · string · required

description · string

For Model 1.0, descriptions must be under 300 bytes, and for other models, they must not exceed 1500 bytes.

photo_id · string

welcome_msg · string

If you want to change the default greeting message of the avatar, you can use this parameter to replace it.

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