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

# 接口总览

> TokenDog API 参考的组织方式与接入建议

## 使用概述

本页说明 TokenDog API 参考的组织方式与接入建议。API 参考分为**指南**、**端点**与**示例**三部分，建议先读本页再按需跳转。

## 基础接入信息

* 统一 `BaseUrl` 为 `https://tokendog.io`。
* 调用具体接口时，在该地址后拼接对应 endpoint 路径，例如 `https://tokendog.io/v1/chat/completions`。

## 导航概览

<CardGroup cols={3}>
  <Card title="先选接口格式" href="/zh/api-reference/examples/basic-chat">
    **Start Here** —— 先确定你用哪种接口格式，再进入对应端点页，避免在不相关接口间来回跳。

    你会在这里看到：OpenAI 兼容 → `/v1/chat/completions`、`/v1/responses`；Claude → `/v1/messages`；Gemini → `/v1beta/...:generateContent`。
  </Card>

  <Card title="理解速率限制" href="/zh/api-reference/guide/rate-limits">
    **Limits** —— 把请求频率、并发和输出大小当成工程约束，而不是上线后再补的补丁。

    你会在这里看到：请求窗口、并发上限、超量处理策略。
  </Card>

  <Card title="定位错误来源" href="/zh/api-reference/guide/error-codes">
    **Debug** —— 错误码页用于快速判断失败发生在鉴权、参数、限流还是服务端链路。

    你会在这里看到：鉴权失败、参数校验、服务端异常。
  </Card>
</CardGroup>

## 推荐阅读顺序

<Steps>
  <Step title="选接口格式">先确认你要用的接口格式：OpenAI 兼容、Claude 或 Gemini。</Step>
  <Step title="对接端点">进入对应端点页，直接照着请求结构对接。</Step>
  <Step title="补齐工程约束">最后用速率限制和错误码文档补齐工程约束与排障路径。</Step>
</Steps>

## 接入建议

* 先确认请求会发到统一 `BaseUrl` `https://tokendog.io`，再按所选接口格式拼接具体 endpoint。
* 如果你已经确定要接 OpenAI、Claude、Gemini，或智谱 GLM、MiniMax，直接进入对应端点页。
* 如果你还在梳理业务流程，先看使用示例，再回到具体端点页落地实现。
* 如果你要做统一平台层，建议把 provider 差异收敛在服务端网关。
