Quick Start

Get started with Konpro API

Welcome to the Konpro API!

Konpro API expands what you can do with Konpro, allowing you to generate advanced avatar videos programmatically and integrate Konpro's AI-driven capabilities into your product. Unlock the potential of Konpro's intelligent video platform! Step into the future of video creation – happy AI video making!

πŸ“˜

Note:

The Konpro API is available separately from the Konpro App.

Your Konpro App plan – Free, Creator, Team, or Enterprise – determines which features and limits you can access in the web app.

Every Konpro App user automatically receives trial access to the Konpro API, which includes endpoints for Video Generation, Video Translation, and Interactive Avatars. For larger usage, subscription tiers are available: Pro, Scale, and Enterprise. For limits and pricing, refer to the usage guide.

Prerequisites

Create a Konpro account

Create a Konpro account. After signing up, you can start making professional avatar videos using Konpro's AI tools.

Access your API key

  1. After registering, go to Account Settings.
    Step 1 - Account Settings
  2. Navigate to APIs & Subscription β†’ Your API Keys β†’ API Token.
    Step 2 - APIs & Subscription
  3. Copy your unique API token for authentication.
    Step 3 - Copy API Token

Settings β†’ APIs & Subscription β†’ Your API Keys β†’ API Token

If you don’t have an existing API key:

    Step 4 - Create New Key
  1. Click Create New Key.
    Step 5 - Name and Create Key
  2. And , Enter a name for your key and click Create Key.
    Step 6 - Copy New API Key
  3. Copy your newly generated API key; it will appear under Your API Keys.
    Step 6 - Copy New API Key
  4. And you can see it under Your API Keys.
    Step 6 - Copy New API Key

Quickly Create an Avatar Video

You can use the video/generate endpoint to programmatically create MP4 videos featuring Konpro's AI avatars. Below is an example in test mode.

Note: Videos created on the Free Trial will contain a watermark.

Request

bash
curl -X POST 'https://api.konpro.ai/v1/video/generate' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{
  "video_inputs": [
    {
      "character": {
        "type": "avatar",
        "avatar_id": "Daisy-inskirt-20220818",
        "avatar_style": "normal"
      },
      "voice": {
        "type": "text",
        "input_text": "Welcome to the Konpro API!",
        "voice_id": "2d5b0e6cf36f460aa7fc47e3eee4ba54"
      },
      "background": {
        "type": "color",
        "value": "#008000"
      }
    }
  ],
  "dimension": {
    "width": 1280,
    "height": 720
  }
}'

You'll get a response containing the ID of the generated video.

Instead of input_text, you can also provide an input_audio field that points to a public audio URL.

If bulk generation is needed, Konpro also supports Template endpoints for reusing layouts and designs efficiently.

Check Video Status

After submitting your request, check whether the video is processed using the video status endpoint.

bash
curl -X GET 'https://api.konpro.ai/v1/video_status.get?video_id=<video_id>' \
-H 'x-api-key: <your-api-key>'

When complete, the status will display as completed.

The returned video URL is valid for 7 days (with an expiry timestamp included in the URL).

Download the Video

Once your video is ready, download it using the provided URL.

bash
curl <video_url> --output first_video.mp4

Conclusion

The Konpro API empowers developers, creators, and businesses to generate professional AI-driven avatar videos at scale. By creating a Konpro account and using your API key, you can integrate advanced video automation into your workflows or products.

Table of Contents