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

开始前准备

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

常见使用方式

地址与协议对照

上表用于帮助选择接入方式。先看接口与模型能力矩阵确认模型与协议,字段级参数与响应结构见Chat Completions 接口,模型当前可用性仍以模型广场为准。

按模型支持的协议选择接口

同一个 Base URL 不表示所有模型都支持同一种请求格式。请按使用场景选择:
Responses 的适用范围仅当模型的 supported_endpoint_types 包含 openai-response 时,才使用 /v1/responses。若收到 status_code=500, not implemented,表示当前协议不匹配;请改用该模型标明支持的接口。Claude Code 使用原生 Messages 配置。

地址为什么可能不同

通用 OpenAI 风格请求通常使用:
部分客户端要求填写不带 /v1 的站点地址,或会自动补全 /chat/completions、/responses、/messages 等路径。请以对应工具教程为准;图片模型则按图片模型使用说明调用。
避免重复路径如果客户端会自动补全 /v1,手动填写后可能形成 /v1/v1/... 并导致 404。遇到 404 时,先检查客户端实际请求地址。

区分客户端配置与通用 API

CLI 工具、编辑器插件和自建程序可能使用不同的协议及配置文件。即使模型名称相同,也不能直接把某个工具的整段配置复制到另一种工具中。 判断方法:
  • 配置 Codex CLI:阅读 Codex 教程,使用 Responses 相关配置。
  • 配置 Claude Code:阅读 Claude Code 教程,使用 Anthropic Messages 相关配置。
  • 自己写文本程序:优先从 Chat Completions 开始。
  • 调用图片:使用图片接口;文本聊天接口不接受图片生成参数。
  • 不确定时:先确认客户端名称和它实际发出的请求路径。

API 参考文档

先阅读接口与模型能力矩阵确认当前模型该用的协议;Chat Completions 的最小请求见Chat Completions 接口。不同模型的可选字段请以所用客户端协议和控制台模型广场为准。 本帮助中心负责解释“如何选择和使用”,并给出可直接验证的最小请求。

如何确认配置成功

  • 客户端可以正常返回完整内容。
  • 控制台使用日志中出现对应请求。
  • 日志中的模型、分组和消费符合预期。
如果调用失败,请保存错误原文和 Request ID,然后进入问题自查。