> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flatkey.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Flatkey REST API：端点、认证与请求格式

> Flatkey 在 https://router.flatkey.ai/v1 提供兼容 OpenAI 的 REST API。所有请求都需要 Bearer token，并通过 HTTPS 发送 JSON。

Flatkey API 是完全兼容 OpenAI API 规范的 REST API。所有请求都发送到 `https://router.flatkey.ai/v1`，所有端点、供应商和模型共用同一个基础 URL。认证方式是在 `Authorization` 请求头中传入 Bearer token。

## 基础 URL

```
https://router.flatkey.ai/v1
```

## 认证

所有请求都必须将 Flatkey API 密钥作为 Bearer token 传入：

```
Authorization: Bearer sk-fk-your-api-key
```

请在[控制台](https://console.flatkey.ai/keys?lng=zh)中生成 API 密钥。完整说明请参阅[认证](/zh/api-reference/authentication)。

## 请求格式

* 所有请求都使用 **HTTPS**
* 请求体必须为 **JSON**（`Content-Type: application/json`）
* 响应为 JSON，流式传输时为 SSE

## 可用端点

| 端点                       | 方法   | 说明                            |
| ------------------------ | ---- | ----------------------------- |
| `/v1/chat/completions`   | POST | 对话与文本生成（兼容 OpenAI）            |
| `/v1/responses`          | POST | OpenAI Responses API（有状态多轮对话） |
| `/v1/embeddings`         | POST | 文本嵌入                          |
| `/v1/images/generations` | POST | 图片生成                          |
| `/v1/models`             | GET  | 列出可用模型                        |

## OpenAI SDK 兼容性

由于 API 兼容 OpenAI，你可以直接使用官方 OpenAI Python 或 Node.js SDK，无需修改请求代码，只需设置 `base_url`：

<CodeGroup>
  ```python python theme={null}
  from openai import OpenAI

  client = OpenAI(
      api_key="sk-fk-your-api-key",
      base_url="https://router.flatkey.ai/v1",
  )
  ```

  ```javascript node theme={null}
  import OpenAI from "openai";

  const client = new OpenAI({
    apiKey: "sk-fk-your-api-key",
    baseURL: "https://router.flatkey.ai/v1",
  });
  ```
</CodeGroup>

## 版本管理

Flatkey 使用与 OpenAI API 相同的版本管理方案。`/v1` 路径前缀保持稳定。OpenAI 发布新 API 版本时，Flatkey 会在保持 `/v1` 向后兼容的同时增加支持。

## 速率限制

速率限制按 API 密钥应用。超出限制时，你会收到 `429 Too Many Requests` 响应。如生产工作负载需要更高限制，请联系 [support@flatkey.ai](mailto:support@flatkey.ai)。

## 支持的内容类型

| 内容类型                | 用途                     |
| ------------------- | ---------------------- |
| `application/json`  | 所有请求体和响应               |
| `text/event-stream` | 流式响应（`stream: true` 时） |