文档中心返回首页
文档 / 开始使用

GETTING STARTED

FlowModel 产品文档

使用一个 API Key 调用多个 AI 供应商和模型。本页覆盖控制台操作、模型选择、接口调用、任务查询和费用管理,可通过目录直接跳转阅读。

i

产品定位统一 AI API 网关:提供供应商目录和价格比较,并将不同厂商的鉴权、任务状态与计费格式统一起来。

平台操作流程

从零开始使用平台,请按以下顺序完成:

  1. 1
    注册并进入控制台

    使用工作邮箱注册。首页显示剩余额度、最近调用和服务状态。

  2. 2
    充值或绑定自有供应商

    选择按量充值,或在供应商设置中绑定获授权的商业 API 密钥(BYOK)。

  3. 3
    创建 API Key

    进入“API 密钥”,新建密钥并设置名称、模型权限和预算上限。密钥仅完整显示一次。

  4. 4
    比较并测试模型

    在模型市场按视频、图像、音频或文本筛选;比较价格、耗时和服务状态后在调试台试跑。

  5. 5
    提交任务并查询结果

    确认预估费用后提交。平台返回任务 ID,完成后可下载结果。

  6. 6
    查看用量与账单

    按密钥、模型或时间查看费用明细和失败退款。

API 快速开始

API 使用 Bearer Token 鉴权,统一入口为:

BASE URLhttps://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画质稳定时使用
routingfixed 或 auto批量任务建议 auto
max_cost单次最高费用生产环境建议设置
!

价格说明首页是参考价;提交前返回实时预估,最终以时长、分辨率和供应商账单为准。

视频生成 API

视频生成是异步任务。提交成功不代表已经完成,请通过任务查询或 Webhook 获取最终状态。

字段类型必填说明
modelstring模型 ID
promptstring建议不超过 500 字
image_urlstring图生视频参考图地址
durationnumber视频秒数
aspect_ratiostring16:9、9:16 或 1:1

任务查询与下载

curl https://api.flowmodel.cn/v1/tasks/task_v_8f21 \n  -H "Authorization: Bearer $FLOWMODEL_API_KEY"

状态为 queuedprocessingsucceededfailed。成功后 output.url 是临时下载地址,默认保留 7 天。

i

生产建议前 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代码处理方法
400invalid_request检查模型参数
401invalid_api_key检查密钥状态
402insufficient_credit充值或降低规格
429rate_limit_exceeded指数退避重试
503provider_unavailable稍后重试或启用自动路由

速率限制

限制按 API Key 和模型计算。X-RateLimit-Remaining 表示剩余额度,Retry-After 表示建议等待秒数。

常见问题

为什么价格会变化?

视频价格受时长、分辨率和供应商实时计价影响,提交前会显示最新预估。

能否直接替换已有接口?

文本接口兼容常见请求结构;视频和图像因异步特性,需使用任务接口。

生成结果保留多久?

默认 7 天,生产业务应及时下载到自己的对象存储。

平台能力

连接、路由、计费并治理模型流量

在统一运营界面管理凭据、路由规则、计费控制、请求日志和访问策略。

一个密钥调用所有模型

发放一个 API Key、分配分组,并让所有客户端保持同一接口契约。

了解详情 →

策略驱动路由

按优先级、权重、模型和渠道健康度路由,无需修改客户端代码。

了解详情 →
$

透明成本控制

在统一计费界面跟踪额度、充值、模型价格和使用量。

了解详情 →

运营级监控

实时查看请求日志、延迟、错误和各渠道路由健康状态。

了解详情 →

企业可信能力

能支撑真实流量的控制能力

统一治理上游供应商、访问权限、计费一致性和审计基线。

供应商治理

集中管理上游凭据、路由优先级和可用性规则。

计费一致性

让使用日志、额度记录和价格规则在用户与团队之间保持一致。

企业访问控制

支持管理员控制、分销场景、团队权限和受保护路由。

安全基线

支持 JWT 鉴权、通行密钥、OAuth、速率限制和便于审计的可见性。

运行模型

三步从上游密钥接入生产流量

01

连接供应商

在管理控制台中一次性添加获授权的上游账户,并映射模型名称。

阅读操作说明 →
{ }02

交付一个 API 契约

让应用指向兼容 OpenAI、Claude 或 Gemini 的统一路由。

阅读操作说明 →
03

观测每个请求

利用日志、排行和计费数据持续调优路由决策。

阅读操作说明 →

准备好上线你的网关

上线一个更清晰的 AI API 业务首页,并把产品能力直接展示出来。

把注册、支付、渠道监控、价格和 API 兼容性变成一个像真实控制台一样可感知的首页。
产品文档 ↗