主题
接口选择与通用约定
选择协议
表格较宽时,可左右滑动查看完整内容。
| 项目 | 原生 OpenAPI · 新项目推荐 | OpenAI 兼容接口 |
|---|---|---|
| 适用场景 | 自行开发图片、视频生成应用 | 已适配视频异步协议的平台 |
| Base URL(基础地址) | https://api.video.aistarslab.com/openapi | https://api.video.aistarslab.com/openai |
| 模型选择 | 配置中的 channel 和 model | 模型列表中的完整 channel:model ID |
| 创建入口 | /generation/create/image 或 /generation/create/video | 图片、视频均为 /v1/videos |
| 创建返回的任务 ID | data.taskId | id |
| 成功状态 | 数字 3 | 字符串 completed |
| 结果地址 | data.outputs 数组 | metadata.result_url |
兼容接口提供模型列表、异步任务创建、查询及内容下载,不表示支持 OpenAI 的全部 API。图片生成也使用异步 /v1/videos 协议,不使用同步图片接口。详细字段见兼容接口参考。
请求地址与鉴权
Base URL 已包含 /openapi 或 /openai,后续接口路径均相对于对应的 Base URL,直接拼接即可,无需重复添加协议前缀。cURL 示例使用完整请求地址。
http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json两套接口使用同一种平台 API Key。JSON 请求使用 UTF-8;密钥保存在自己的服务端,通过环境变量读取。创建与管理方式见获取 API Key。
原生接口响应
原生 OpenAPI(含素材上传)使用以下外层结构:
表格较宽时,可左右滑动查看完整内容。
| 字段 | 类型 | 说明 |
|---|---|---|
| code | integer | 0 表示请求成功,非零表示请求失败 |
| msg | string | 返回消息 |
| data | object / array | 成功时的业务数据,具体类型以各接口为准 |
同时检查 HTTP 状态和 code。创建请求成功仅表示已受理,最终生成结果需要通过任务状态判断。兼容接口不使用这层包装,失败请求返回 error 对象。
任务状态
表格较宽时,可左右滑动查看完整内容。
| 含义 | 原生接口 | 兼容接口 |
|---|---|---|
| 等待执行 | 1 | queued |
| 执行中 | 2 | in_progress |
| 成功(终态) | 3 | completed |
| 失败(终态) | 4 | failed |
原生接口生成类型 type=1 表示图片,type=2 表示视频。进度仅用于展示,结束判断以状态为准。重试与错误判断见错误处理与轮询。
示例约定
- 快速开始中的
test线路可在替换 Key 后直接运行,不扣生成积分,也不真实生成内容。 example-image-model、example-video-model及example.com素材地址仅演示结构;正式调用须替换为实时配置与可访问素材。- cURL 示例使用 Bash 语法。在 Windows 可使用 Git Bash,或使用快速开始中的 Python 示例。
- 本站 JSON 类型
integer为整数,number为数值,array<string>为字符串数组;自定义对象的字段在相应接口页展开。