Sprite Plus
目的
根据起始帧和可选的结束帧生成精灵动画。此功能与 Web 应用「生成精灵」页面(Sprite Lite & Plus)的 Plus 标签页相同。使用 frame 选择帧数,与 Web 页面滑块上显示的值完全一致。
代币消耗: 9(49 帧)、13(81 帧)
方法与路径
POST /public/v1/sprite/plus
认证
请参阅认证页面。需要 Bearer Token。
必需请求头:
Authorization: Bearer {your_api_key}
请求字段
请以 multipart/form-data 形式发送请求。
| 字段名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| start_image | file | 是 | 起始帧(PNG 或 JPEG) | |
| end_image | file | 否 | 结束帧(可选)(PNG 或 JPEG) | |
| text | string | 是 | 描述动作的提示词。空白会被去除,且文本不能为空 | |
| frame | integer | 是 | 帧数。允许的值:49、81 | |
| is_pixel | boolean | 否 | false | 像素风。如果附加图片本身是像素风,请开启此选项 |
| is_prompt_enhancement | boolean | 否 | true | 提示词优化。根据你输入的内容,将提示词优化为更适合生成精灵的形式 |
按 frame 划分的代币
| frame | 代币 |
|---|---|
| 49 | 9 |
| 81 | 13 |
响应
成功响应(200 OK):
{
"job_id": "uuid-string"
}
| 字段 | 类型 | 说明 |
|---|---|---|
| job_id | string | 已创建任务的唯一标识符。使用 Get Job Status 查询结果 |
错误 / 校验规则
| 情况 | HTTP 状态 | 错误消息 |
|---|---|---|
| 任一图片不是有效的 PNG 或 JPEG 文件 | 400 | "Invalid image file" |
| frame 值不被允许 | 400 | "frame should be one of 49, 81" |
| text 为空 | 400 | "text must not be empty" |
| API Key 无效 | 401 | "Invalid API key" |
| 缺少字段 | 422 | 校验错误 |
异步任务行为
此端点会创建异步任务。它会立即返回 job_id,实际的精灵生成会在后台进行。
轮询方法:
- 保存响应中收到的
job_id - 轮询
GET /public/v1/job/{job_id}检查状态 - 当状态变为
Succeed时,在image_urls中查看结果(精灵图和 GIF)
状态流: Pending → Succeed 或 Failed
请求示例
cURL(仅起始帧):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/plus" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "start_image=@/path/to/character.png" \
-F "text=walking animation" \
-F "frame=49" \
-F "is_pixel=true"
cURL(起始帧 + 结束帧):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/plus" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "start_image=@/path/to/character_start.png" \
-F "end_image=@/path/to/character_end.png" \
-F "text=running animation cycle" \
-F "frame=81"