生成特效 V1

用途

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

方法和路径

POST /public/v1/generate/effect/v1

认证

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

必需头信息：

Authorization: Bearer {your_api_key}

请求字段

字段名	类型	必需	说明
description	string	是	要生成的特效的文本描述
resolution	string	是	输出分辨率。可用值: 1K, 2K, 4K
image	file	否	用于引导生成特效的可选参考图片

响应

成功响应 (200 OK)：

{
  "job_id": "uuid-string"
}

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

错误 / 验证规则

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

异步作业行为

此端点创建异步作业。请求会立即返回 job_id，实际特效生成会在后台进行。

轮询方法：

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

状态流程： Pending → Succeed 或 Failed

请求示例

cURL (不含图片)：

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "resolution=1K"

cURL (包含图片)：

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