Skip to content

Repository files navigation

Akool (akool)

About this repository

This is not our API. This repository is an independent, third-party profile of a company's publicly available API surface, maintained by API Evangelist. API Evangelist does not operate, host, resell, or support this company's APIs, and is not affiliated with or endorsed by the company unless stated on the profile.

Where the information came from. Everything here is assembled from material a member of the public can reach with a browser and no credentials — the company's own website, developer portal and documentation, the specifications it publishes for public use (OpenAPI, AsyncAPI, JSON Schema, apis.json, llms.txt and similar), its public repositories, and its public status, pricing and changelog pages. Nothing here is obtained by breaching a system, defeating an access control, or using credentials of any kind.

The rating is an independent assessment. The Kin Score and Agent Readiness rating are independently calculated scores of a company's public API artifacts, produced by API Evangelist against a published rubric. They are not certifications, endorsements, security assessments, or audits, and they score published artifacts — not the quality, safety, or security of the software.

Corrections, re-scores, and removal are free. No partnership, contract, or purchase is required, and you do not need to justify the request.

  • Something wrong? Open an issue on this repository, or email info@apievangelist.com.
  • Published something new? Ask for a re-score and we will re-run the rating.
  • Want the listing taken down? Say so and we will honor it. The profile is reduced to your company name, a factual description, and a link to your own site, and the company is recorded as unrated — never scored zero for having asked.

Response times. Acknowledgement within one business day; removal or restriction within two business days; corrections and re-scores within five business days.

Not from the company, and here with a question? You are welcome here — we would rather be the front line and point you the right way than have a good report go nowhere. What this repository can answer is narrow, though, so it is worth knowing who you are actually looking for:

  • A question about how the API works, an account, billing, or a bug in the service — that is the company's own support, not us. We profile this API; we do not operate it and cannot see your account.
  • A bug in an open-source project we only catalog — file it on that project's own repository. This has happened with a real and correct bug report that reached us instead of the people who could fix it, which helped nobody.
  • Anything about this listing itself — the description, the tags, the rating, a missing or wrong artifact — is ours. Open an issue here.
  • Not sure, or something general about API Evangelist or APIs.io — open an issue on the APIs.io Inbox and we will route it.

This repository contains no software, and we will never ask you to download anything. There is no build, release, installer, or binary here — only text and machine-readable API descriptions, so there is nothing here that can be "corrupt" or need "repairing". Any issue, comment, or email claiming otherwise and offering a download link is not from us and is hostile. Do not follow the link; it is a lure. Report it to GitHub and, if you like, tell us at info@apievangelist.com so we can take it down.

On a security or compliance team? Email info@apievangelist.com with security in the subject line and you will get a person, not a form. We will tell you exactly which public URLs this profile was built from so your team can see the same surface we did, and we will take the listing down on request while you work through it.

Full detail: Where this data comes from

Akool is a generative AI platform for video and imagery - talking avatars, talking photos, face swap, video translation with lip-sync, background change, lip sync, image generation, and a real-time streaming (live) avatar product. The Akool OpenAPI exposes these tools as an HTTPS REST API under https://openapi.akool.com, authenticated with a Bearer token minted from a clientId / clientSecret pair (POST /api/open/v3/getToken) or a direct x-api-key header. Generation is asynchronous: callers create a task, then poll by id or receive an encrypted webhook callback when the task completes.

APIs.json: https://raw.githubusercontent.com/api-evangelist/akool/refs/heads/main/apis.yml

Access Model (honest summary)

  • Public, documented REST API. Akool publishes a full developer area at docs.akool.com (with an llms.txt index and several published OpenAPI files), a public Postman collection, and a GitHub org at AKOOL-Official. This is a real, live API - not a modeled placeholder.
  • Base URL: https://openapi.akool.com, with product endpoints under /api/open/v3 and /api/open/v4.
  • Auth: exchange clientId + clientSecret for a Bearer token at POST /api/open/v3/getToken, or pass a direct x-api-key header (Akool's recommended path). Tokens expire (error code 1101).
  • Async by design: create endpoints return a task id (_id / job_id); poll a status endpoint by id (video_status / image_status / faceswap_status: 1=queueing, 2=processing, 3=completed, 4=failed) or register a webhookUrl for an encrypted completion callback (AES-256-CBC dataEncrypt, SHA-1 signature).
  • API access is plan-gated. Programmatic access is available on the higher subscription tiers (Pro Max and above per the pricing page); generation spends credits and generated assets are retained for 7 days.
  • The OpenAPI in this repo (openapi/akool-openapi.yml) is hand-modeled by API Evangelist from the live documentation. Endpoint paths, methods, auth, and status semantics are grounded in Akool's docs; request/response field lists are representative rather than exhaustive. Akool also publishes its own per-product OpenAPI files (e.g. https://docs.akool.com/openapi/live-avatar.yaml) - consult those and the live docs for complete field detail. Plans, rate limits, and FinOps files are marked reconciled: false where exact prices/limits were not confirmed.
  • Real-time transport, stated precisely. The Live Avatar (Streaming Avatar) product is real-time and bidirectional, but Akool does not expose an Akool-operated WebSocket API. The REST control plane opens a session (POST /api/open/v4/liveAvatar/session/create) whose media is carried over a caller-selected third-party WebRTC transport - stream_type agora (default), livekit, or trtc - using that provider's credentials and SDK. WebRTC media transport belongs to Agora/LiveKit/Tencent, not to a documented Akool WebSocket, so no AsyncAPI document was authored. See review.yml.

Tags

  • AI Avatars
  • Video Generation
  • AI Video
  • Face Swap
  • Generative AI
  • Talking Avatar
  • Video Translation
  • Live Avatar

Timestamps

  • Created: 2026-07-11
  • Modified: 2026-07-11

APIs

Akool Talking Avatar API

Generate an expressive, speaking avatar video from an Akool or user-supplied avatar plus text or an audio track. POST /api/open/v3/talkingavatar/create (avatar_id, voice_id, input_text or audio url), then poll by _id.

Akool Talking Photo API

Turn a still portrait into a talking video by pairing a talking_photo_url with an audio_url. POST /api/open/v3/content/video/createbytalkingphoto, poll GET /api/open/v3/content/video/infobymodelid.

Akool Face Swap API

Swap a source face onto a target image or video, single-face or multi-face. POST /api/open/v4/faceswap/faceswapPlusByImage, results at GET /api/open/v3/faceswap/result/listbyids.

Akool Video Translation API

Translate a source video into one or more target languages with optional lip-sync. GET /api/open/v3/language/list, POST /api/open/v3/content/video/createbytranslate, then poll by _id.

Akool Image Generation API

Text-to-image and image-to-image generation on Flux-family models. POST /api/open/v4/content/image/createBySourcePrompt, poll GET /api/open/v3/content/image/infobymodelid.

Akool Live Avatar (Streaming) API

Real-time, interactive streaming avatars. REST control plane lists avatars (GET /api/open/v4/liveAvatar/avatar/list) and manages sessions (create/list/detail/close). Session media rides a caller-selected WebRTC transport (stream_type agora, livekit, or trtc) via POST /api/open/v4/liveAvatar/session/create - not an Akool WebSocket.

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

Akool is a generative AI platform for video and imagery - talking avatars, talking photos, face swap, video translation with lip-sync, background change, image generation, and a real-time streaming (live) avatar product.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors