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

# 总览

# Portix — 网关、托管工具与 Agent 集成

Portix 同时提供原生公共路由和 converter 路由。这个部分用于说明每个公共 API 的路径、请求格式、认证头、错误行为和限流规则。

## 公共端点协议族

| 请求格式                    | 原生路由                                     | Converter 路由                                    | 适用场景                                                                    |
| ----------------------- | ---------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------- |
| OpenAI Chat Completions | `/v1/chat/completions`                   | `/openai/v1/chat/completions`                   | 调 OpenAI 兼容平台时走原生路由；想保留 OpenAI 格式去调 Anthropic 或 Gemini 时走 converter。    |
| OpenAI Responses        | `/v1/responses`                          | 暂未提供                                            | 调 OpenAI 兼容平台时走原生路由；如果今天要跨协议调用，请先改用 OpenAI Chat Completions converter。  |
| Anthropic Messages      | `/v1/messages`                           | `/anthropic/v1/messages`                        | 调 Anthropic 兼容平台时走原生路由；想保留 Anthropic 格式去调 OpenAI 或 Gemini 时走 converter。 |
| Gemini Generate Content | `/v1beta/models/{model}:generateContent` | `/gemini/v1beta/models/{model}:generateContent` | 调 Gemini 平台时走原生路由；想保留 Gemini 格式去调 OpenAI 或 Anthropic 时走 converter。      |

详细的协议路由规则和错误行为，请参考 [路由与协议](/guides/routing-protocols.zh)。

## 认证

所有公共路由都使用 Portix API Key，不同协议使用不同 Header：

| API 格式    | Header                                   |
| --------- | ---------------------------------------- |
| OpenAI 兼容 | `Authorization: Bearer $PIPELLM_API_KEY` |
| Anthropic | `x-api-key: $PIPELLM_API_KEY`            |
| Gemini    | `x-goog-api-key: $PIPELLM_API_KEY`       |

## Base URL

| 路由类型                | Base URL                          |
| ------------------- | --------------------------------- |
| 原生公共路由              | `https://api.portix.ai`           |
| OpenAI converter    | `https://api.portix.ai/openai/v1` |
| Anthropic converter | `https://api.portix.ai/anthropic` |
| Gemini converter    | `https://api.portix.ai/gemini`    |

## 从这里开始

<Columns cols={2}>
  <Card title="列出模型" icon="list" href="/api-reference/list-models.zh">
    查看当前账号可用的模型 ID
  </Card>

  <Card title="路由与协议" icon="route" href="/guides/routing-protocols.zh">
    先搞清楚该走 free route 还是 converter route
  </Card>

  <Card title="错误" icon="triangle-exclamation" href="/guides/errors.zh">
    查看错误类型、状态码和重试建议
  </Card>

  <Card title="速率限制" icon="gauge" href="/guides/rate-limits.zh">
    查看请求限额、余额保护和返回头
  </Card>
</Columns>

## 端点参考

<Columns cols={3}>
  <Card title="OpenAI 兼容" icon="bolt" href="/api-reference/openai/overview.zh">
    `/v1/chat/completions` 和 `/v1/responses`
  </Card>

  <Card title="Anthropic" icon="message" href="/api-reference/anthropic/overview.zh">
    `/v1/messages`
  </Card>

  <Card title="Gemini" icon="sparkles" href="/api-reference/gemini/overview.zh">
    `/v1beta/models/{model}:generateContent`
  </Card>
</Columns>