跳至正文
橙域智能 文档中心 · 接入指南

从第一次调用开始。

了解接入流程,把模型能力连接到你的应用与开发工具。

快速开始

  1. 进入控制台,使用已有账号登录;企业成员使用管理员提供的专属登录入口。
  2. 在「API 密钥」中创建密钥。密钥仅显示一次,请安全保存,并避免放进浏览器前端代码或公开仓库。
  3. 从账号的 API 密钥或使用说明页面获取接入地址,按客户端协议填写 Base URL 与 API Key。
  4. 在模型列表中选择当前账号可访问的模型,发起请求,再到用量与请求明细中检查结果。

协议与客户端

不同客户端使用的协议和地址后缀不同。请使用控制台提供的实际地址;企业密钥需搭配该企业的专属 API 入口。

OpenAI 兼容客户端

填写 OpenAI 兼容 Base URL(通常以 /v1 结尾)和 API Key。Chat Completions 请求使用 /chat/completions;具体模型与接口支持范围以控制台说明为准。

Anthropic 协议客户端

使用协议根地址,客户端通常会追加 /v1/messages。不要重复填写接口后缀;请参考登录后的使用说明配置对应环境变量。

Gemini 协议客户端

使用控制台提供的 Gemini 兼容地址,通常以 /v1beta 结尾。模型名称、认证方式和请求格式需与客户端要求一致。

发送一次请求

下面是 OpenAI 兼容协议示例。先在本地环境中设置 XELFORA_BASE_URL(完整 Base URL,含 /v1)、XELFORA_API_KEY 和 XELFORA_MODEL。调用会按账号配置产生用量与费用。

curl "${XELFORA_BASE_URL}/chat/completions" \
  -H "Authorization: Bearer ${XELFORA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d @- <<JSON
{"model":"${XELFORA_MODEL}","messages":[{"role":"user","content":"你好"}],"stream":false}
JSON

变量值从你自己的账号获取,不要把密钥发送给他人或粘贴到公开页面。生产环境建议由服务端安全保存密钥。

用量与排障

调用后,在控制台查看请求状态、Token 用量和费用。遇到问题时,优先检查地址、密钥、模型可用范围与账号额度。

  • 认证失败:检查密钥是否有效,是否使用了匹配的企业入口。
  • 模型不可用:核对模型名称与当前账号的模型列表。
  • 限流或额度不足:根据返回的错误信息检查用量配置,避免无间隔重试。
  • 上游异常:记录请求时间及错误信息,联系管理员排查;不要在反馈中附带密钥。

常见问题

为什么不能直接使用首页上的地址调用?

官网用于产品介绍。实际 API 地址可能使用独立域名或企业专属路径,请以登录后账号页面显示的地址为准。

所有账号都能使用所有模型吗?

模型可用范围由组织、渠道和账号配置决定,请查看当前账号的模型列表。

企业登录入口和 API 接入地址是同一个吗?

不是。企业登录使用管理员提供的专属入口,API 请求使用对应协议的专属接入地址。不要把登录页面地址填进 Base URL。

在哪里查看完整的账号专属配置?

登录控制台后,打开「使用说明」与「API 密钥」页面,可查看与你的账号和企业入口对应的配置。

主题颜色

首页与文档中心会同步切换主题颜色。

仅保存在当前浏览器