Getting started
快速开始
鉴权、创建任务、查询任务、积分余额与错误码。
AIGCBoom API 提供图片生成、视频生成、异步任务查询和积分余额查询。
接口列表
| 方法 | 完整路径 | 说明 |
|---|---|---|
| POST | /api/v1/media/generate | 创建图片或视频任务 |
| GET | /api/v1/media/status?task_id={task_id} | 查询任务状态与最终结果 |
| GET | /api/v1/credits/balance | 查询当前账号剩余积分 |
鉴权
所有请求统一使用 Bearer Token:
curl "https://www.aigcboom.com/api/v1/credits/balance" \
-H "Authorization: Bearer sk-..."- API Key 在个人中心 → API Keys 创建。
- 完整 Key 可以随时查看和复制。
- Key 无效或已停用返回
401。 - 超过 Key 积分限额返回
403。
创建任务
POST /api/v1/media/generate
每次请求只生成一张图片或一个视频。请求体结构为 model、prompt 和 params。
{
"model": "gpt-image-2",
"params": {
"images": [
"https://example.com/reference.png"
],
"quality": "auto",
"size": "auto"
},
"prompt": "An orange cat wearing glasses sits by the window reading a book"
}{
"code": 200,
"msg": "任务创建成功",
"data": {
"task_id": "b4f0f0f0-0000-4000-8000-000000000001"
}
}查询任务
GET /api/v1/media/status?task_id={task_id}
curl "https://www.aigcboom.com/api/v1/media/status?task_id=b4f0f0f0-0000-4000-8000-000000000001" \
-H "Authorization: Bearer sk-..."{
"task_id": "b4f0f0f0-0000-4000-8000-000000000001",
"state": "running",
"status": "处理中",
"is_final": false,
"result_url": "",
"result_type": "",
"error": "",
"cost": 3
}- 判定终态请用
is_final === true。 - 判定成功或失败请用
state:pending/running/success/failed。 - 建议每 5~10 秒轮询一次。
- 失败任务会自动退款,不要重复请求同一个
task_id。
积分余额
GET /api/v1/credits/balance
{
"code": 200,
"msg": "查询成功",
"data": {
"total_credits": 12,
"subscription_credits": 0,
"permanent_credits": 12
}
}错误码
| code | 含义 | 处理建议 |
|---|---|---|
| 200 | 成功 | 读取 data |
| 400 | 参数错误 | 检查 model、prompt 和 params |
| 401 | API Key 无效或已停用 | 确认 Authorization Header |
| 403 | API Key 已达到积分限额 | 提高 Key 限额或等待额度释放 |
| 404 | 任务不存在 | 确认 task_id 属于当前账号 |
| 500 | 任务创建失败 | 查看 data.reason;失败任务会自动退款 |