跳到主要内容

特效生成 V2

目的

异步生成特效风格的结果。你可以提供文本描述来引导特效生成,并可选择上传图片。

方法与路径

POST /public/v1/generate/effect/v2

认证

请参阅 认证 页面。需要 Bearer 令牌。

必需头信息:

Authorization: Bearer {your_api_key}

请求字段

字段名类型必填说明
descriptionstring特效描述
qualitystring输出质量:standard, pro
framenumber帧数:4, 9, 16
imagefile可选参考图片

响应

成功响应 (200 OK):

{
"job_id": "uuid-string"
}
字段类型说明
job_idstring创建的作业的唯一标识符。使用 获取任务状态 查询结果

错误 / 验证规则

情况HTTP 状态错误消息
Invalid image file400"Invalid image file"
API 密钥无效401Invalid API key

异步任务行为

该端点会创建异步任务。请求会立即返回 job_id,实际特效生成会在后台进行。

轮询方法:

  1. 保存响应中收到的 job_id
  2. 轮询 GET /public/v1/job/{job_id} 检查状态
  3. 当状态变为 Succeed 时,从 image_urls 查看结果

状态流程: PendingSucceedFailed

请求示例

cURL (不含图片):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "quality=standard" \
-F "frame=4"

cURL (包含图片):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a neon cyberpunk effect" \
-F "quality=pro" \
-F "frame=16" \
-F "image=@/path/to/input.png"