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

# XRouter 文档

> 使用 XRouter 的统一 API Key 接入 OpenAI SDK、Claude Code、Codex CLI、CC-Switch 和兼容 API。

XRouter 提供统一的 API Key 和兼容接口，让应用代码、AI 编程工具和本地 Provider 管理工具都能接入同一个服务地址。

<Info>
  本文档默认 API 服务地址为 `https://api.xrouter.dev`。如果控制台显示了不同的服务地址，请以控制台中的 `server_address` 为准。
</Info>

## 先选你的接入方式

<Columns cols={2}>
  <Card title="应用代码 / OpenAI SDK" icon="code" href="/integrations/openai-sdk">
    把 SDK 的 base URL 改成 XRouter，继续使用 OpenAI 兼容调用方式。
  </Card>

  <Card title="Claude Code" icon="bot" href="/integrations/claude-code">
    通过 Anthropic Messages 兼容接口，把 Claude Code 指向 XRouter。
  </Card>

  <Card title="Codex CLI" icon="terminal" href="/integrations/codex-cli">
    在 Codex CLI 中添加 XRouter 自定义模型供应商。
  </Card>

  <Card title="CC-Switch" icon="repeat-2" href="/integrations/cc-switch">
    用图形界面管理 Claude、Codex 和 Gemini Provider。
  </Card>
</Columns>

## 推荐阅读顺序

<Steps>
  <Step title="完成快速开始">
    创建 API Key，确认服务地址，并用 `/v1/models` 和 Chat Completions 验证密钥可用。
  </Step>

  <Step title="确认接口格式">
    如果你还没决定使用哪种接口，先阅读“选择接入方式”，再进入对应工具或 API 页面。
  </Step>

  <Step title="接入你的工具或应用">
    应用代码优先看 OpenAI SDK；Claude Code、Codex CLI 和 CC-Switch 分别有独立配置页。
  </Step>

  <Step title="出现问题时查看日志">
    请求失败时先确认认证头、模型名和服务地址，再到控制台用量日志里定位具体请求。
  </Step>
</Steps>

## 核心端点

| 场景                      | 端点                                            | 认证方式                               |
| ----------------------- | --------------------------------------------- | ---------------------------------- |
| OpenAI Chat Completions | `https://api.xrouter.dev/v1/chat/completions` | `Authorization: Bearer sk-...`     |
| OpenAI Responses        | `https://api.xrouter.dev/v1/responses`        | `Authorization: Bearer sk-...`     |
| Anthropic Messages      | `https://api.xrouter.dev/v1/messages`         | `x-api-key: sk-...` 或 Bearer token |
| Gemini 兼容               | `https://api.xrouter.dev/v1beta/models/...`   | `x-goog-api-key` 或 `key` 查询参数      |

<Tip>
  如果你只需要兼容 OpenAI SDK，通常只要把 `base_url` 或 `baseURL` 改成 `https://api.xrouter.dev/v1`，再使用 XRouter API Key。
</Tip>