OpenAPI Overview

Bring KPainter Into Your Product With OpenAPI

If you want to generate and manage content directly inside your own product, OpenAPI is the better fit.

First Steps

If this is your first integration, go in this order:

1. start with Authentication and Quickstart
2. then go to the content-specific pages for Explainer Video / Slides / Image / Interactive Lessons
3. in implementation, read /catalog first, then create, poll, and read the final detail response

If your product also accepts natural-language requests, build the “user wording -> API type” mapping on each content-type page before you ship the create flow.

With it, your users can create:

• Explainer Video
• Slides
• Image
• Interactive Lessons

Get an API Key First

Before integration starts, send users to the main site to get their own API key.

• open the API Key page
• activate or view the current API key
• copy the key before calling GET /me

If you are building your own product integration, this should be part of your connect flow.

What Your Product Can Do

• start creation jobs
• poll generation progress
• read finished creation details
• fetch result URLs, artifacts, and scene data
• keep editing supported content types

The Endpoints You Will Use Most

• /me
  validate the current API key first
• /catalog
  load available types, languages, voices, styles, and limits
• /creations
  create, read, and edit content

Supported API Types

Legacy input aliases are still accepted for compatibility:

• knowledge_video -> explainer_video
• web_app -> interactive_lesson

/catalog, creation results, list responses, detail responses, and MCP resources now return the canonical public names.

Two Integration Rules That Matter Most

Read /catalog first

Types, languages, voices, styles, qualities, durations, and page limits should all come from /catalog.

Read results from the detail response

GET /creations/{creation_id} already returns usable result URLs, artifacts, and scene data, so you usually do not need to add another export layer.

Read Next

• Quickstart
  get a minimum working flow for auth, create, polling, and result reads
• API Reference
  browse concrete endpoints by group
• Authentication
  read key handling, validation, and error expectations
• Explainer Video / Slides / Image / Interactive Lessons
  go deeper on creation, type mapping, and result handling for each content type

How API Keys Work

OpenAPI calls should use the user's own API key.

Viewing, activating, rotating, and invalidating API keys still happens on the main site's API Key page.