> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jogg.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Quick start guide for JoggAI API

## 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.

<CardGroup cols={4}>
  <Card title="Create Account" icon="user-plus" href="#create-account">
    Sign up and get your API key
  </Card>

  <Card title="Pricing" icon="dollar-sign" href="/api-reference/v2/QuickStart/Pricing">
    View credit pricing
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/api-reference/v2/QuickStart/ErrorHandling">
    Understand error codes
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/api-reference/v2/QuickStart/RateLimits">
    Manage API usage
  </Card>
</CardGroup>

***

## Create Account

Sign up to create an account at [https://app.jogg.ai/register](https://app.jogg.ai/register) to access JoggAI's API capabilities.

***

### Get Your API Key

<Steps>
  <Step title="Sign In">
    Log in to [JoggAI](https://app.jogg.ai/login)
  </Step>

  <Step title="Navigate to API Settings">
    Click your avatar → Select "API" from the menu

    <img src="https://mintcdn.com/joggai/2WfnmgQwwQkeXdv3/images/apikey20251215.png?fit=max&auto=format&n=2WfnmgQwwQkeXdv3&q=85&s=bcf49e942268f846b5b98571cdae1191" alt="" width="3840" height="1986" data-path="images/apikey20251215.png" />
  </Step>

  <Step title="Copy Your Key">
    Copy your API key and store it securely

    <img src="https://mintcdn.com/joggai/2WfnmgQwwQkeXdv3/images/apikey120251215.png?fit=max&auto=format&n=2WfnmgQwwQkeXdv3&q=85&s=88b116056e4132e3fb985c12b7c89a2c" alt="" width="958" height="528" data-path="images/apikey120251215.png" />

    <Warning>
      **Keep your API key secure!** Never expose it in client-side code or public repositories.
    </Warning>
  </Step>
</Steps>

### Test Your API Key

Include your API key in the request header:

```bash theme={null}
curl -X GET 'https://api.jogg.ai/v2/user/whoami' \
  -H 'x-api-key: YOUR_API_KEY'
```

**Expected Response:**

```json theme={null}
{
  "code": 0,
  "msg": "Success",
  "data": {
    "email": "user@example.com",
    "username": "johndoe"
  }
}
```

***

## Quick Start Example

Here's a simple example to create an avatar video:

```bash theme={null}
  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"
    }'
```

<Tip>
  See our \[Workflows Guides]\(/api-reference/v2/API Documentation/CreateAvatarVideos) for detailed examples and use cases.
</Tip>

***

## Need Help?

For questions or issues:

* **Email:** [support@jogg.ai](mailto:support@jogg.ai)
* **Dashboard:** [app.jogg.ai](https://app.jogg.ai)
* **Documentation:** Explore our workflow guides for detailed examples

<Note>
  Include your user ID (not API key) when contacting support.
</Note>

Looking for legacy API documentation? Click [here](/api-reference/v1/QuickStart/GettingStarted).