用 OpenAPI 把 KPainter 接进你的产品
如果你想在自己的产品里直接生成和管理内容,而不是只在 agent 里触发,OpenAPI 会更合适。
第一次接入建议
如果你是第一次接入,建议按这个顺序看:
- 先看
身份认证和快速开始 - 再按内容类型看
知识视频 / PPT / 图片 / 互动课程 - 真正实现时,先读
/catalog,再创建、轮询、读取详情
如果你的产品还要接自然语言输入,建议先在每种内容类型页里把“用户说法 -> API type”的映射接好,再上线创建逻辑。
接入后,你可以让用户通过 API 生成:
- 知识视频
- PPT
- 图片
- 互动课程
先获取 API Key
开始接入前,先让用户到主站获取自己的 API Key。
- 进入 API Key 页面
- 激活或查看当前 API Key
- 复制 key 后再发起
GET /me校验
如果你在做自己的产品集成,建议在你的连接流程里直接引导用户打开这个页面完成授权准备。
你的产品能做到什么
- 发起创建任务
- 轮询生成进度
- 读取成品详情
- 获取结果 URL、附件和场景数据
- 对支持的内容继续编辑
你最常用的接口
/me
先验证当前 API Key 是否可用/catalog
读取类型、语言、音色、风格和限制/creations
创建、查询和编辑内容
支持的 API 类型
| API type | 生成结果 |
|---|---|
explainer_video |
完整知识视频 |
slides_video |
知识视频(图解版) |
vector_animation |
矢量动画 |
slide_deck |
PPT / PDF 幻灯片 |
image |
图片 |
interactive_lesson |
互动课程 |
兼容说明:
- 历史入参
knowledge_video仍兼容,会归一到explainer_video - 历史入参
web_app仍兼容,会归一到interactive_lesson
/catalog、创建结果、列表、详情和 MCP 资源现在统一返回正式名。
两个接入原则
先读 /catalog
类型、语言、音色、风格、质量、时长和页数限制,都应以 /catalog 为准。
结果直接从详情接口拿
GET /creations/{creation_id} 会直接返回可用的结果 URL、附件和场景信息,通常不需要你额外再造一层导出流程。
接下来读什么
快速开始
先拿到一套最小可跑通的请求、轮询和结果读取流程API 参考
按接口分组查具体能力身份认证
看 API Key 的传递方式、校验和错误处理知识视频 / PPT / 图片 / 互动课程
按具体内容类型看创建方式、类型映射和结果重点
API Key 怎么处理
OpenAPI 调用使用用户自己的 API Key。
API Key 的查看、激活、重置和失效,仍然在主站的 API Key 页面 完成。
