GETTING STARTED
FlowModel 产品文档
使用一个 API Key 调用多个 AI 供应商和模型。本页覆盖控制台操作、模型选择、接口调用、任务查询和费用管理,可通过目录直接跳转阅读。
产品定位统一 AI API 网关:提供供应商目录和价格比较,并将不同厂商的鉴权、任务状态与计费格式统一起来。
平台操作流程
从零开始使用平台,请按以下顺序完成:
- 1注册并进入控制台
使用工作邮箱注册。首页显示剩余额度、最近调用和服务状态。
- 2充值或绑定自有供应商
选择按量充值,或在供应商设置中绑定获授权的商业 API 密钥(BYOK)。
- 3创建 API Key
进入“API 密钥”,新建密钥并设置名称、模型权限和预算上限。密钥仅完整显示一次。
- 4比较并测试模型
在模型市场按视频、图像、音频或文本筛选;比较价格、耗时和服务状态后在调试台试跑。
- 5提交任务并查询结果
确认预估费用后提交。平台返回任务 ID,完成后可下载结果。
- 6查看用量与账单
按密钥、模型或时间查看费用明细和失败退款。
API 快速开始
API 使用 Bearer Token 鉴权,统一入口为:
https://api.flowmodel.cn/v1设置环境变量
export FLOWMODEL_API_KEY="fm_live_xxxxxxxxx"查看可用模型
curl https://api.flowmodel.cn/v1/models \n -H "Authorization: Bearer $FLOWMODEL_API_KEY"提交视频生成任务
curl -X POST https://api.flowmodel.cn/v1/videos/generations \n -H "Authorization: Bearer $FLOWMODEL_API_KEY" \n -H "Content-Type: application/json" \n -d '{"model":"veo-3.1-fast","prompt":"雨夜东京的银色跑车","duration":5,"aspect_ratio":"16:9"}'响应示例
{"id":"task_v_8f21","status":"queued","estimated_cost":1.32,"currency":"CNY"}模型目录与智能路由
模型 ID 是稳定调用标识。只有选择 routing: "auto" 时,上游不可用才会自动切换兼容模型。
| 参数 | 说明 | 建议 |
|---|---|---|
model | 指定模型 ID | 画质稳定时使用 |
routing | fixed 或 auto | 批量任务建议 auto |
max_cost | 单次最高费用 | 生产环境建议设置 |
价格说明首页是参考价;提交前返回实时预估,最终以时长、分辨率和供应商账单为准。
视频生成 API
视频生成是异步任务。提交成功不代表已经完成,请通过任务查询或 Webhook 获取最终状态。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型 ID |
prompt | string | 是 | 建议不超过 500 字 |
image_url | string | 否 | 图生视频参考图地址 |
duration | number | 否 | 视频秒数 |
aspect_ratio | string | 否 | 16:9、9:16 或 1:1 |
任务查询与下载
curl https://api.flowmodel.cn/v1/tasks/task_v_8f21 \n -H "Authorization: Bearer $FLOWMODEL_API_KEY"状态为 queued、processing、succeeded 或 failed。成功后 output.url 是临时下载地址,默认保留 7 天。
生产建议前 30 秒每 5 秒查询一次,之后每 15 秒查询;高并发业务优先使用 Webhook。
Webhook 回调
在控制台添加 HTTPS 地址并选择事件。平台为回调附带 X-FM-Signature,请使用 Webhook Secret 校验 HMAC-SHA256 和时间戳。
X-FM-Event: video.succeeded
X-FM-Signature: t=1787980000,v1=...
{"event":"video.succeeded","task_id":"task_v_8f21","output":{"url":"https://cdn.example/video.mp4"}}API 密钥管理
- 开发、测试、生产环境分别创建密钥。
- 为每个密钥设置月预算与允许调用的模型。
- 不要在浏览器前端、移动客户端或公开仓库中暴露密钥。
- 发现泄露后立即撤销并轮换。
额度、计费与退款
支持预付额度和获授权的 BYOK。预付额度按成功调用扣减;因平台或上游错误失败时自动退回冻结金额。
| 状态 | 含义 |
|---|---|
| reserved | 任务已提交,预估费用暂时冻结 |
| settled | 任务成功,按实际用量结算 |
| refunded | 生成失败,冻结金额已退回 |
安全与合规
仅对接官方商业 API、企业授权渠道或用户自带的合法 API 密钥,不共享会员账号,也不模拟网页会员权益。
- 传输全程使用 HTTPS。
- 供应商密钥加密存储,界面仅显示掩码。
- 提示词和结果按保留策略自动清理。
- 调用需遵守供应商内容政策和适用法律。
错误码
| HTTP | 代码 | 处理方法 |
|---|---|---|
| 400 | invalid_request | 检查模型参数 |
| 401 | invalid_api_key | 检查密钥状态 |
| 402 | insufficient_credit | 充值或降低规格 |
| 429 | rate_limit_exceeded | 指数退避重试 |
| 503 | provider_unavailable | 稍后重试或启用自动路由 |
速率限制
限制按 API Key 和模型计算。X-RateLimit-Remaining 表示剩余额度,Retry-After 表示建议等待秒数。
常见问题
为什么价格会变化?
视频价格受时长、分辨率和供应商实时计价影响,提交前会显示最新预估。
能否直接替换已有接口?
文本接口兼容常见请求结构;视频和图像因异步特性,需使用任务接口。
生成结果保留多久?
默认 7 天,生产业务应及时下载到自己的对象存储。