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

# 接入方式总览

> NexusAPI：接入方式总览

NexusAPI 支持主流 AI 客户端和 OpenAI 风格的接口调用。不同工具可能会自动拼接路径，因此应根据使用方式填写地址。

## 开始前准备

无论使用哪种方式，都需要：

1. 在控制台创建 API Key。
2. 确认 API Key 所属分组包含目标模型。
3. 从模型广场复制准确的模型 ID。
4. 确认目标模型支持的接口类型，再使用 HTTPS 地址发起请求。

## 常见使用方式

| 使用方式             | 建议阅读                                   |
| ---------------- | -------------------------------------- |
| 自建程序或脚本          | [5 分钟快速开始](/guide/quick-start)         |
| Claude Code      | [Claude Code 配置教程](/tools/claude-code) |
| Codex CLI        | [Codex CLI 配置教程](/tools/codex-cli)     |
| CC Switch        | [CC Switch 配置教程](/tools/cc-switch)     |
| VS Code / Cursor | [编辑器插件教程](/tools/cursor-vscode)        |
| 图片生成             | [图片模型使用说明](/guide/image-generation)    |

## 地址与协议对照

| 场景                  | 填写地址                       | 主要协议               | 注意事项                      |
| ------------------- | -------------------------- | ------------------ | ------------------------- |
| OpenAI SDK / 通用文本程序 | `https://nexusapi.link/v1` | Chat Completions   | 请求路径由 SDK 或程序拼接           |
| Codex CLI           | `https://nexusapi.link/v1` | Responses          | 使用 Codex 教程中的 Provider 配置 |
| Claude Code         | `https://nexusapi.link`    | Anthropic Messages | 不要在配置地址后重复添加 `/v1`        |
| CC Switch           | 按 Provider 类型填写            | 取决于目标工具            | Claude 与 Codex 的地址规则不同    |
| 图片模型                | `https://nexusapi.link/v1` | Images             | 仅使用模型广场标明支持图片的模型          |

上表用于帮助选择接入方式。先看[接口与模型能力矩阵](/developer/capability-matrix)确认模型与协议，字段级参数与响应结构见[Chat Completions 接口](/developer/openai-compatible)，模型当前可用性仍以模型广场为准。

## 先选择正确的协议

同一个 Base URL 不表示所有模型都支持同一种请求格式。请按使用场景选择：

| 你要做什么                         | 推荐接口                     | 说明                         |
| ----------------------------- | ------------------------ | -------------------------- |
| 通用文本、聊天、流式输出                  | `/v1/chat/completions`   | 大多数 OpenAI 兼容 SDK 和自建程序的首选 |
| Codex CLI 等明确要求 Responses 的工具 | `/v1/responses`          | 仅在模型与渠道明确支持时使用             |
| Claude Code 或原生 Anthropic 客户端 | `/v1/messages`           | 客户端会根据其配置补全路径              |
| 图片生成                          | `/v1/images/generations` | 只适用于支持图片的模型                |

<Warning>
  **当前 Anthropic 类型 Claude 渠道不要直接使用 Responses**

  如果用 `/v1/responses` 调用当前平台的 Anthropic 类型 Claude 渠道并收到 `status_code=500, not implemented`，请改用 `/v1/chat/completions`；使用 Claude Code 时则保持其原生 Messages 配置。不要原样重试。
</Warning>

## 地址为什么可能不同

通用 OpenAI 风格请求通常使用：

```text theme={"system"}
https://nexusapi.link/v1
```

部分客户端要求填写不带 `/v1` 的站点地址，或会自动补全 `/chat/completions`、`/responses`、`/messages` 等路径。请以对应工具教程为准；图片模型则按[图片模型使用说明](/guide/image-generation)调用。

<Warning>
  **避免重复路径**

  如果客户端会自动补全 `/v1`，手动填写后可能形成 `/v1/v1/...` 并导致 404。遇到 404 时，先检查客户端实际请求地址。
</Warning>

## 客户端配置和通用 API 不要混用

CLI 工具、编辑器插件和自建程序可能使用不同的协议及配置文件。即使模型名称相同，也不能直接把某个工具的整段配置复制到另一种工具中。

判断方法：

* 配置 Codex CLI：阅读 Codex 教程，使用 Responses 相关配置。
* 配置 Claude Code：阅读 Claude Code 教程，使用 Anthropic Messages 相关配置。
* 自己写文本程序：优先从 Chat Completions 开始。
* 调用图片：使用图片接口，不要向文本聊天接口传图片生成参数。
* 不确定时：先确认客户端名称和它实际发出的请求路径。

## API 参考文档

先阅读[接口与模型能力矩阵](/developer/capability-matrix)确认当前模型该用的协议；Chat Completions 的最小请求见[Chat Completions 接口](/developer/openai-compatible)，完整字段、请求结构和响应结构见 [Apifox 接口参考](https://nexusapi.apifox.cn/)。

帮助中心负责解释“如何选择和使用”；API 参考负责说明“字段和结构是什么”。

## 如何确认配置成功

* 客户端可以正常返回完整内容。
* 控制台使用日志中出现对应请求。
* 日志中的模型、分组和消费符合预期。

如果调用失败，请保存错误原文和 Request ID，然后进入[问题自查](/faq/self-check)。