Skip to main content
POST
/
v2
/
photo_avatar
/
add_motion
Add Motion to Photo Avatar
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!"
}
'
{
  "code": 0,
  "msg": "Success",
  "data": {
    "motion_id": "<string>",
    "status": "<string>"
  }
}
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"
  }'

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