跳到主要内容

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_imagefile是起始帧(PNG 或 JPEG)
end_imagefile否结束帧(可选)(PNG 或 JPEG)
textstring是描述动作的提示词。空白会被去除,且文本不能为空
frameinteger是帧数。允许的值:49、81
is_pixelboolean否false像素风。如果附加图片本身是像素风,请开启此选项
is_prompt_enhancementboolean否true提示词优化。根据你输入的内容,将提示词优化为更适合生成精灵的形式

按 frame 划分的代币

frame代币
499
8113

响应​

成功响应(200 OK):

{
"job_id": "uuid-string"
}
字段类型说明
job_idstring已创建任务的唯一标识符。使用 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,实际的精灵生成会在后台进行。

轮询方法:

  1. 保存响应中收到的 job_id
  2. 轮询 GET /public/v1/job/{job_id} 检查状态
  3. 当状态变为 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"