Skip to main content

​
Welcome to JoggAI API

The JoggAI API unlocks new possibilities, enabling you to effortlessly create dynamic avatar videos and seamlessly integrate JoggAI’s advanced AI features into your product.

Create Account

Sign up and get your API key

Pricing

View credit pricing

Error Handling

Understand error codes

Rate Limits

Manage API usage

​
Create Account

Sign up to create an account at https://app.jogg.ai/register to access JoggAI’s API capabilities.

​
Get Your API Key

1

Sign In

Log in to JoggAI
2

Navigate to API Settings

Click your avatar → Select “API” from the menu
3

Copy Your Key

Copy your API key and store it securely
Keep your API key secure! Never expose it in client-side code or public repositories.

​
Test Your API Key

Include your API key in the request header: 
curl -X GET 'https://api.jogg.ai/v2/user/whoami' \
  -H 'x-api-key: YOUR_API_KEY'
Expected Response: 
{
  "code": 0,
  "msg": "Success",
  "data": {
    "email": "[email protected]",
    "username": "johndoe"
  }
}

​
Quick Start Example

Here’s a simple example to create an avatar video: 
  curl -X POST  https://api.jogg.ai/v2/create_video_from_avatar \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
      "avatar": {
        "avatar_type": "0",
        "avatar_id": 412
      },
      "voice": {
        "type": "script",
        "voice_id": "MFZUKuGQUsGJPQjTS4wC",
        "script": "测试一下"
      },
      "aspect_ratio": "portrait",
      "screen_style": 1,
      "caption": true,
      "webhook_url": "your_webhook_url",
      "video_name": "My Talking Avatar Video"
    }'
See our [Workflows Guides](/api-reference/v2/API Documentation/CreateAvatarVideos) for detailed examples and use cases.

​
Need Help?

For questions or issues:
Include your user ID (not API key) when contacting support.
Looking for legacy API documentation? Click here.