KonPro API Documentation

Complete API documentation for creating AI-powered avatars, managing voices, generating videos, and integrating interactive avatar widgets into your applications. The API is RESTful and returns JSON responses.

Overview

KonPro provides a comprehensive API for creating AI-powered avatars, managing voices, generating videos, and integrating interactive avatar widgets into your applications. The API is RESTful and returns JSON responses.

Base URL

All API requests should be made to:

https://api.konpro.ai

Authentication

API Key Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers:

x-api-key: YOUR_API_KEY

Generating API Keys

To generate an API key for your application:

1. Visit KonPro Studio
2. Log in to your account
3. Navigate to the API Keys section in the Settings page
4. Click "Generate New Key"
5. Copy and securely store your API key

Example API Request

curl -X GET https://api.konpro.ai/v1/avatars \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

// JavaScript/Node.js example
const response = await fetch('https://api.konpro.ai/v1/avatars', {
    headers: {
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
});

API Endpoints

Rate Limiting

API requests are rate limited to ensure fair usage and system stability.

Default Limits

• Public API: 100 requests per minute
• Studio API: 60 requests per minute
• Inference API: 10 requests per minute
• Widget Sessions: 20 sessions per hour

Rate Limit Headers

All responses include rate limit information:

Error Handling

The API uses standard HTTP status codes to indicate success or failure of requests.

HTTP Status Codes

Error Response Format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is invalid",
    "details": {
      "field": "avatar_id",
      "reason": "Avatar ID is required"
    }
  },
  "request_id": "req-123456"
}