把 KPainter 接入你的产品
KPainter OpenAPI 适合需要在自己的产品、自动化流程或 Agent 中创建内容的开发者。它提供三种公开能力:
| 产品 | type | 适合 |
|---|---|---|
| 解说视频 | video | 课程、培训、SOP、研究解读、产品教育和知识讲解 |
| AI 生图 | image | 海报、封面、插画和单张视觉创意 |
| AI 应用 | app | 互动网页、模拟器、测验和小工具 |
PDF、PPT、文档和图片都是输入素材,不决定最终产品。解说视频还可以直接使用网页 URL 作为内容来源。
基础地址
正式请求都从这里开始:
https://api.kpainter.ai/openapi/v1
例如,读取当前账号可用能力的完整地址是:
https://api.kpainter.ai/openapi/v1/capabilities
一次完整创建流程
- 用 GET /me 确认 API Key。
- 用 GET /capabilities 获取当前可用参数。
- 如有附件,先用 POST /files 上传。
- 用 POST /creations 创建 video、image 或 app。
- 用 GET /creations/{id} 查询状态和进度。
- 完成后用 GET /creations/{id}/outputs 获取可用结果。
- 解说视频可用 messages 继续修改;任务暂停时,只执行 available_actions 中返回的操作。
常用接口
| 接口 | 用途 |
|---|---|
| GET /health | 检查服务是否可访问 |
| GET /me | 校验当前账号 |
| GET /capabilities | 获取产品、参数、模板和模型 |
| POST /files | 上传输入文件 |
| POST /creations | 创建内容 |
| GET /creations | 查询当前账号的创建记录 |
| GET /creations/{id} | 查询状态、进度、预计时间和积分 |
| POST /creations/{id}/messages | 继续修改解说视频 |
| POST /creations/{id}/actions | 继续最新暂停任务 |
| GET /creations/{id}/outputs | 获取已通过检查的交付结果 |
接入时需要注意
- 鉴权统一使用 Bearer API Key。
- 请求和响应字段统一使用 snake_case。
- 只发送 capabilities 当前返回的参数值。
- 普通失败不会返回实际消费积分。
- 没有可靠估算时,不会返回预计剩余时间。
- 完成后从输出接口读取可用结果,不要自行拼接下载地址。
