Developer docs
快速开始
创建个人 API Key,提交第一个异步生成任务,并使用 Firefly 任务 ID 查询图片、视频或语音结果。
开始前准备
你需要一个 Firefly 客户账号和一把状态正常的个人 API Key。API Key 明文只在创建或轮换成功时显示一次。
只在服务端环境变量中保存 API Key,不要写入浏览器代码、Git 仓库、日志或公开聊天记录。
四步完成调用
创建 Key
在控制台创建个人 API Key,并仅保存在服务端。
提交任务
选择模型,并使用对应的图片、视频或语音接口。
轮询状态
使用返回的任务 ID 查询,直到进入终态。
读取输出
成功时读取 output,失败时读取 error。
第一个请求
先设置 FIREFLY_API_KEY 环境变量。以下默认使用第一个已发布图片模型演示,代码会提交任务、轮询状态并输出最终结果。
模型示例暂时无法加载。
查询模型列表
GET /v1/models 使用个人 API Key 查询全平台已上架模型,包含文本、图片、视频和音频。无需请求参数,一次返回全部结果,不分页。
curl --fail-with-body "https://api.fireflyfusion.ai/v1/models" \
-H "Authorization: Bearer $FIREFLY_API_KEY"响应示例(仅展示一项):
{
"models": [
{
"id": "gemini-3.7-flash",
"type": "text"
}
]
}models[].id 是请求中 model 字段使用的模型标识。结果按标识排序,没有已上架模型时 models 为 []。
models[].type 表示平台模型分类:text(文本)、image(图片)、video(视频)、audio(音频)、multimodal(多模态),不表示全部输入模态。
此接口返回精简目录格式,不兼容 OpenAI SDK 的标准模型列表解析。
每次请求读取最新发布目录;完成上架发布后即可查询,下架后不再返回。
列表不按当前用户的调用权限过滤,也不保证渠道实时可用。调用时仍需具备权限和足够余额,并使用该模型支持的接口;图片、视频和音频模型不一定支持聊天接口。
缺少或无效 API Key 返回 401,Key 无调用权限或 IP 不被允许返回 403,服务暂不可用返回 503。 错误处理