AKOOL

docs.akool.com

AKOOL is a breakthrough Generative AI platform for personalized visual marketing and advertising. With AKOOL, marketing creators and innovators can build custom, engaging experiences that pull people inside the brand in a way that converts them into loyal customers.

llms.txt

Akool open api documents

Docs

AI Model: Get available AI models for different generation tasks including text-to-image, image-to-video, and more.
Character Swap API Overview: Comprehensive guide to the Character Swap API
Create Character Swap: Create animated video from character image and source video using WaveSpeed AI's advanced animation models
Get Video Info Result: Retrieve character swap video results by ID
ErrorCode: Error codes and meanings
Face Detection API Overview: Comprehensive guide to the Face Detection API
Analyze Frames: Face analysis for single or multiple images with automatic person deduplication
Detect Faces: Unified endpoint to detect faces in either video or image from URL or base64-encoded image
Face Swap API Overview: Comprehensive guide to the Face Swap API
Delete Faceswap Results: Delete faceswap results by IDs
Face Detect (Legacy): Detect faces in images and get landmark information
Face Swap Plus (Image & Video): Multi-face swap for images and videos
Get User Credit Info: Get faceswap user credit information
Get Faceswap Result List: Get faceswap results by IDs
Image Faceswap: Swap faces in images with high quality
Face Swap Pro: Highest quality face swap for images
Video Faceswap: Swap faces in videos with high quality
Create Head Swap Task: Create a head-swap video generation task using the same video_url as analysis and obj_id to reference-face mappings.
Get Analysis Result (Head Swap): Poll head-swap person analysis status and read detected people (obj_id, preview URLs, optional video_info).
Get Head Swap Task Detail: Poll head-swap generation task status, progress, and output video URL by task _id.
Head Swap API Overview: Guide to the Head Swap Open API: detect people in a source video, then create head-swap generation tasks.
Submit Person Analysis (Head Swap): Submit a head-swap scene analysis job to detect people in a source video and obtain obj_id values for mapping.
Generate 4K or Variations: Upscale images to 4K or generate variations from existing image generation results
Text to Image / Image to Image: Generate images from text prompts or transform existing images using WaveSpeed AI models
Get Image Result: Retrieve image generation results by ID
Image Generate API Overview: Comprehensive guide to the Image Generate API
Create Batch Image to Video: Create multiple videos from images in a single request with AI-powered animation
Create Image to Video: Transform a static image into a dynamic video with AI-powered animation, effects, and audio
Delete Videos: Delete generated Image to Video results by IDs
Get Available Effects: List all available video effects for Image to Video
Get Image to Video Results: Retrieve image to video generation results by IDs
Image to Video API Overview: Comprehensive guide to the Image to Video API
Update Video Audio: Add or replace audio on a generated Image to Video result
Jarvis Moderator
Knowledge Base: Create and manage knowledge bases with documents and URLs to enhance Streaming Avatar AI responses, providing contextual information for more accurate and relevant interactions
LipSync
Streaming Avatar API Overview: Comprehensive guide to the Streaming Avatar API
Close Session: Close an active streaming avatar session
Create Session: Create a new streaming avatar session
Get Streaming Avatar Detail: Retrieve detailed information about a specific streaming avatar
Get Streaming Avatar List: Retrieve a list of all streaming avatars
Get Session List: Retrieve a list of all streaming avatar sessions
Get Session Detail: Retrieve detailed information about a specific streaming avatar session
Upload Streaming Avatar: Create a new streaming avatar from a video URL
Vision Sense
Live Face Swap: Real-time Face Swap API Documentation
Reage
Talking Avatar: Talking Avatar API documentation
Talking Photo API Overview: Comprehensive guide to the Talking Photo API
Create By Talking Photo: Create animated video from photo and audio
Get Video Info Result: Retrieve talking photo video results by ID
Video Translation API Overview: Comprehensive guide to the Video Translation API for multilingual video content
Create Video Translation: Translate videos into multiple languages with AI voices and lip-sync
Get Language List: Retrieve supported languages for video translation
Get Video Translation Result: Check the status and retrieve results of video translation jobs
VoiceLab: VoiceLab API documentation
Webhook
Usage
Change Logs: API release notes and version history
CLI: Create AI-powered media from the terminal. Drive AKOOL with code, not clicks.
LiveKit Agent Integration: Set up and run a LiveKit Agent server for Streaming Avatar integration
Streaming Avatar Integration Guide: Learn how to integrate streaming avatars using Agora, LiveKit, or TRTC SDK
Akool AI Tools Suite Documentation: Comprehensive documentation for Akool AI tools including face swap, voice lab, video translation, and more.
MCP: Connect AKOOL AI capabilities to Claude, Cursor, Codex, and any MCP-compatible client.
Streaming Avatar SDK API Reference: Complete API documentation for akool-streaming-avatar-sdk
Streaming Avatar SDK Best Practices: Learn how to implement the Akool Streaming Avatar SDK securely and efficiently
Streaming Avatar SDK Quick Start: Learn what is the Streaming Avatar SDK