跳至正文
文档目录
开始使用 / 文档首页

开发者文档

拿到橙域 API Key 后,先准备接入信息,再查询模型并发送第一条请求。

统一接入文档

先准备这三项

API KEY

橙域 API Key

形如 sk-...,只保存在本地环境变量或服务端。

OPENAI BASE URL

OpenAI API 地址

使用交付给你的公网或企业专属地址;本页示例要求地址以 /v1 结尾。

MODEL

模型 ID

从当前 Key 鉴权后的模型列表复制,不能根据模型名称猜测。

如果你只拿到了 API Key,还需要向管理员或交付方索要对应的 API 地址。橙域 API Key 不是任何上游厂商的 Key。

环境变量配置

先复制下面的变量模板,再运行模型查询和调用示例。企业地址请直接使用管理员或交付方提供的完整地址;如果你只有 API Key,请先索要地址。

OpenAI 兼容客户端

Shell / macOS / Linux
# 使用管理员或交付方提供的完整地址(不要自行拼接路径)
export XELFORA_OPENAI_BASE_URL="<管理员提供的 OpenAI Base URL(以 /v1 结尾)>"
export XELFORA_API_KEY="sk-你的Key"
export XELFORA_MODEL="<从 /v1/models 返回的 model id>"

# OpenAI 兼容客户端(Codex、OpenAI SDK 等)
export OPENAI_BASE_URL="$XELFORA_OPENAI_BASE_URL"
export OPENAI_API_KEY="$XELFORA_API_KEY"

Qwen、DeepSeek、GLM、Kimi、MiniMax 和腾讯混元等模型,统一使用 OpenAI 兼容地址。

Claude Code / Anthropic 兼容

Shell / macOS / Linux
# 使用管理员或交付方提供的 Anthropic 协议根地址
export XELFORA_ANTHROPIC_BASE_URL="<管理员提供的 Anthropic Base URL(不要追加 /v1)>"
export ANTHROPIC_API_KEY="$XELFORA_API_KEY"

# Claude Code 使用协议根地址
export ANTHROPIC_BASE_URL="$XELFORA_ANTHROPIC_BASE_URL"

# Claude Code 可选:关闭归因头与非必要遥测
export CLAUDE_CODE_ATTRIBUTION_HEADER=0
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1

Anthropic Base URL 填协议根地址,不要在这里提前追加 /v1。

把地址和 sk-你的Key 替换成管理员或交付方提供的真实值;不要自行拼接企业标识,也不要把 Key 提交到 Git、前端代码或截图中。

API 地址怎么填

不同协议对 Base URL 的处理方式不同。为避免重复拼接版本路径,公开文档使用三个含义明确的环境变量。

协议环境变量地址规则
OpenAI 兼容XELFORA_OPENAI_BASE_URL填写已经包含 /v1 的完整地址;调用时只继续追加 /models、/chat/completions 或 /responses。
Anthropic 兼容XELFORA_ANTHROPIC_BASE_URL填写协议根地址;Claude Code 会在其后请求 /v1/messages。
Gemini 兼容XELFORA_GEMINI_BASE_URL填写已经包含 /v1beta 的完整地址。
复制 OpenAI 示例时,不要重复追加 /v1。个人 Key 使用交付的公网地址;企业 Key 使用对应的企业专属地址。

查询当前可调用模型

模型清单由当前 API Key 的授权决定。先执行 GET /v1/models,再从响应的 data 数组复制准确的 id。

GET /v1/models
curl "${XELFORA_OPENAI_BASE_URL}/models" \
  -H "Authorization: Bearer ${XELFORA_API_KEY}"
如果出现“API key 没有支持得分组”或列表里没有需要的模型,说明当前 Key 尚未获得对应分组或发布授权;请联系管理员,不要自行猜测型号。

发送第一次调用

把模型列表返回的准确 id 保存为 XELFORA_MODEL,再调用 OpenAI 兼容入口。

POST /v1/chat/completions
curl "${XELFORA_OPENAI_BASE_URL}/chat/completions" \
  -H "Authorization: Bearer ${XELFORA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "${XELFORA_MODEL}",
    "messages": [{"role": "user", "content": "你好"}],
    "stream": false
  }'
首次验证先使用普通文本和非流式请求。连接成功后,再按具体模型逐项验证流式输出、工具调用或视觉能力。

接下来,选择你的接入方式

模型页回答“如何调用某类模型”,工具页回答“在某个客户端里应该填什么”。

协议与 API

橙域网关对外提供三类兼容协议。下表是完整请求路径;具体能力仍取决于当前 Key、模型 ID 和分组授权。

OpenAI 兼容GET /v1/models
POST /v1/chat/completions
POST /v1/responses
Anthropic 兼容POST /v1/messages
POST /v1/messages/count_tokens
Gemini 兼容GET /v1beta/models
POST /v1beta/models/{model}:generateContent

常见错误

401:API Key 无效

检查 Key 是否完整、是否已停用,以及认证头是否为 Authorization: Bearer。

403:当前地址或模型无权访问

如果提示“API key 没有支持得分组”,请联系管理员绑定可用分组;企业 Key 需要使用交付的专属 API 地址,模型也必须出现在当前 Key 的模型列表中。

429:请求过于频繁

降低并发或等待后重试,不要使用无间隔循环重试。

常见问题

以下内容涵盖平台、接入、计费、隐私与企业服务等常见问题。

01

平台介绍

橙域智能是做什么的?什么是模型聚合平台?

我们是一个 AI 大模型 API 聚合平台(API 网关)。我们将多家模型厂商(如 DeepSeek、通义千问、Kimi、GLM 等)的模型统一接入到一个平台。你只需要注册一个账号、生成一个 API Key,就可以调用多家、多种大模型,无需分别去各家官网注册、付费和维护账号。

通过橙域智能调用,和直接去 DeepSeek、GLM 官方购买有什么区别?

每家厂商需要单独注册,不同厂商通常需要分别支付、切换配置;通过橙域智能,只需要一个账号、配置一次。不同厂家模型的计费方式不同,平台会按模型记录调用次数和产生的费用,账单更清晰透明。

支持哪些模型?

目前支持 DeepSeek、通义千问、Kimi、GLM 等模型。模型列表会持续更新,可在文档中心的模型接入中查看最新模型和接入方式。

支持团队和多 Key 管理吗?

支持。可以按用户、部门和 API Key 管理不同访问权限。

02

安全性与稳定性

我的 API Key 安全吗?你们如何存储?

平台对 API Key 做加密存储,数据库不保存明文密钥;建议不要把 Key 提交到代码仓库、不要在公开场合粘贴;一旦怀疑泄露,立即在工作台删除并重建令牌。

平台本身稳定吗?如何保障可用性?

平台采用多渠道聚合架构:同一模型配置多条上游通道,系统实时监测各通道健康度,自动进行负载均衡;某条通道故障时秒级切换备用通道,并自动失败重试。

03

接入与使用

接入需要改很多代码吗?

不需要。多数情况下只需要替换 base_url 和 api_key。

可以在 Cherry Studio、WorkBuddy、ChatBox、LobeChat、沉浸式翻译等第三方客户端中使用吗?

可以。凡是支持自定义厂商接口地址的客户端均可使用:接口地址填管理员或交付方提供的 https://【你的域名】/v1(部分客户端只填域名),API Key 填本平台令牌,模型名填写平台支持的模型名称即可。

支持哪些编程语言 / SDK?

任何能发 HTTP 请求的语言都可以。Python、Node.js、Go、Java 无需替换,改 Base URL 即用。

不写代码的员工是不是不能用?

可以用。企业级 AI 网关全员可用,适配多场景,可以处理公司公文、制度、表格等材料,只需要为需要的员工分配 API Key。

我们已经采购了部分模型,新增购买会不会很麻烦?

非常简单。我们按量计费,选择模型后真实使用才会有 Token 消耗。已有订阅与当前不冲突,可以使用 cc switch 管理多个订阅。

有文档吗?

有。文档中心包含各类指南,如何使用、常见问题均可查询。

如何联系客服 / 获取技术支持?

拨打 400 860 1508 或扫码添加官方客服微信。

04

计费与账单

费用如何查看?

工作台会记录请求量、Token、模型 ID、费用。支持按部门管理,随时可查,清晰透明。

如何计费?

按 Token 用量计费,用多少扣多少,无最低消费、无月费。

一次请求大概花多少钱?如何估算?

后台模型广场列出了每个模型每百万 Token 的价格,输入和输出分开计价。例如某模型输入 3 / 百万 Tokens、输出 15 / 百万 Tokens,一次 1000 字左右的问答通常消耗约 2000~3000 Tokens。

请求失败也扣费吗?

不扣费。仅在模型成功返回内容时才会计费;请求失败,如上游错误、超时、内容拦截,不消耗额度。

如何查看消费明细?

登录工作台 →「用量与资金 - 请求明细 · 用量」,可查看每次请求的时间、模型、Token 用量、消耗金额,支持按时间、模型、令牌筛选。额度变动流水可在「余额账本」查看。

为什么实际扣费和我预估的不一样?

常见原因:

1. 上下文长度:多轮对话中,历史消息会作为输入重复计费,对话越长,单次消耗越高。

2. 预扣费与结算:流式请求会先按预估额度预扣,结束后按实际用量多退少补,页面刷新后即为最终扣费。

3. 补全倍率:输出部分单价高于输入,输出多的请求费用更高。

4. 函数调用 / 工具定义:传入的工具描述也会占用输入 Token。

大客户 / 企业采购有专属折扣吗?

有。请联系官方客服获取专属折扣。

多人 / 多项目使用如何隔离?

可为每个项目、每个成员创建独立令牌,单独设置额度与权限,互不影响。企业版支持多租户、按部门 / 项目拆分账单。

怎么购买?

首页扫码联系官方客服。

05

隐私保护

你们会保存我的对话内容吗?

平台仅在提供服务的必要范围内处理请求数据:用于计费(Token 数量)、故障排查和滥用防护。计费所需的 Token 统计数据会保留,供你在工作台查询。

我的数据会被用于训练模型吗?

不会。我们不会将你的请求数据用于训练任何模型,也不会出售给第三方。上游模型厂商的数据政策以各厂商条款为准,官方直连渠道同样不使用客户数据训练。

你们会看我的 API Key 吗?

管理员在正常业务流程中无法查看你的令牌明文(加密存储)。请勿通过客服聊天工具发送完整 Key;排查问题时只需提供令牌名称或后 4 位。

06

合规与企业服务

平台业务合规吗?

平台依据《生成式人工智能服务管理暂行办法》等法规要求开展业务,我们已完成备案,向企业客户提供 API 技术服务,不直接面向公众提供内容生成服务。

能开发票吗?

支持。请扫码联系官方客服或拨打 400 860 1508 电话咨询。

能签合同 / 走对公采购流程吗?

可以。支持签署服务合同、对公转账、按企业需求定制专属折扣,请联系客服。