跳转到主要内容
大约五分钟即可完成第一次 Flatkey 请求。你只需要一个 API 密钥,以及兼容 OpenAI 的基础 URL https://router.flatkey.ai/v1
已经在使用 OpenAI SDK?保留现有请求代码,只需把基础 URL 改为 https://router.flatkey.ai/v1

开始之前

你需要:
  • 一个 Flatkey 账号
  • cURL、Python 3.8+、Node.js 16+ 或 PowerShell
  • 足以完成模型请求的预付费额度
1

设置账号和 API 密钥

登录 Flatkey 控制台。打开 钱包,选择适合工作负载的预付费套餐。在 Flatkey 钱包中选择预付费套餐接下来打开 API 密钥,并选择 创建 API 密钥打开 API 密钥页面并选择创建 API 密钥为密钥设置清晰的名称。选择 保存更改 前,还可以设置额度上限和过期时间。设置 Flatkey API 密钥的名称、额度和有效期复制生成的密钥并安全保存。Flatkey API 密钥以 sk-fk- 开头。
切勿把 API 密钥提交到源代码仓库,也不要在浏览器端代码中暴露密钥。请使用环境变量或密钥管理服务。
2

发送第一次请求

在当前终端中设置 API 密钥:
Python 用户可运行 pip install openai 安装 OpenAI SDK;TypeScript 用户可运行 npm install openai。cURL 和 PowerShell 不需要 SDK。以下示例通过同一个 Flatkey 端点调用同一个模型:
请求完成后,打开 Flatkey 控制台中的 使用日志。在 模型名称 中输入 gpt-4o-mini,然后选择 搜索。下图显示了筛选器的位置;完成的请求应出现在表格中,并显示 Token 数量、延迟和费用。在 Flatkey 使用日志中使用模型名称筛选器如果表格仍显示 未找到日志,请等待几秒后重新搜索。如果仍然为空,请确认请求使用的 API 密钥和基础 URL。
3

继续构建

将 Flatkey 连接到你使用的编程工具:

Claude Code

手动配置 Claude Code,或使用 CC Switch。

Codex CLI

通过 Flatkey 路由 Codex CLI 请求。

Codex 桌面端

手动配置 Codex 桌面端,或使用 CC Switch。

读取响应

对于 Chat Completions 响应,最常使用的字段包括:
  • choices[0].message.content — 生成的文本
  • model — 处理请求的模型
  • usage — 输入、输出和总 Token 数量
完整结构请参阅 Chat Completions 参考

流式接收响应

如果希望在 Token 生成时立即接收,请将 stream 设置为 true

处理常见错误

响应格式和故障排除方法请参阅 API 错误

后续步骤

身份验证

了解 Flatkey API 密钥和身份验证请求头的工作方式。

模型目录

查找支持的模型 ID 和当前价格。

OpenAI SDK

在 OpenAI Python 和 TypeScript SDK 中使用 Flatkey。

使用日志

监控请求、Token 用量、延迟和费用。

计费

了解预付费额度和用量费用。