FIM Gate 文档
API 参考

API 总览

FIM Gate 的端点族、鉴权方式与通用调用约定一览。

FIM Gate 是大模型 API 聚合转发服务:一个 API Key,按三种接口风格调用多家厂商的模型。本页介绍端点族划分、鉴权方式和所有接口共用的约定。

端点族

接口风格Base URL鉴权 Header典型场景
OpenAI 兼容(推荐)https://api.gate.fim.ai/v1Authorization: Bearer $FIM_API_KEY用一套 OpenAI 格式调用绝大多数模型,含流式、多模态、工具调用
Claude 原生https://api.gate.fim.ai(端点 /v1/messages)x-api-key: $FIM_API_KEY请求/响应字段需与 Anthropic Messages API 逐字段一致
Gemini 原生https://api.gate.fim.ai(端点 /v1beta/...)x-goog-api-key: $FIM_API_KEY请求/响应字段需与 Google Gemini API 逐字段一致,流式走 ?alt=sse

三种风格背后是同一个账户和同一份额度,按需选择即可。如果没有特殊的字段对齐需求,建议统一走 OpenAI 兼容接口。

鉴权

在控制台创建 API Key 后,把它放进对应接口风格的 Header 里。Key 等同于账户额度的使用凭证,请只保存在服务端环境变量中,不要写进前端代码或公开仓库。

export FIM_API_KEY="sk-..."

文档导航

OpenAI 兼容接口:

厂商原生接口:

除上述对话类接口外,FIM Gate 还提供 OpenAI 兼容的图像与音频端点:

通用约定

请求格式

  • 所有请求体均为 JSON,需携带 Content-Type: application/json。
  • 模型通过请求体中的 model 字段指定(Gemini 原生风格下模型名写在 URL 路径里)。实时可用的模型列表与价格见 gate.fim.ai/pricing。

流式输出

三种风格都支持 Server-Sent Events(SSE)流式输出:

  • OpenAI 兼容:请求体设 "stream": true
  • Claude 原生:请求体设 "stream": true
  • Gemini 原生:改用 :streamGenerateContent 方法并附加查询参数 ?alt=sse

HTTP 状态码

状态码含义处理建议
400请求体格式或参数不合法核对 JSON 结构与字段取值
401API Key 缺失或无效检查 Header 名称与 Key 本身
404路径不存在核对 Base URL 与端点拼写
413请求体超出大小限制压缩输入内容或拆分请求
429触发速率限制降低请求频率,配合指数退避重试
500网关或上游内部错误稍后重试
503服务暂时不可用上游维护或过载,稍后重试

速率限制的具体阈值与账户等级相关,收到 429 时降低请求频率并按指数退避重试即可。

计费

按各模型的输入/输出 token 用量计费,每个响应的 usage 字段会返回本次消耗。各模型单价以 gate.fim.ai/pricing 为准。