OpenAI Compatible

接入 OpenAI 兼容 API

将兼容客户端的 Base URL 改为 https://api.xmapi.me/v1,使用支持 OpenAI 兼容协议的分组 API Key,并从模型广场选择当前可用的模型标识。

Base URLhttps://api.xmapi.me/v1
鉴权Authorization: Bearer <API_KEY>
模型从模型广场复制当前模型标识

准备工作

  1. 注册并登录,在控制台创建 API Key。
  2. 为 Key 选择当前支持 OpenAI 兼容协议的分组。
  3. 打开模型广场,确认模型属于该分组并复制模型标识。
  4. 把 Key 放入服务端环境变量,不要写入浏览器代码或公开仓库。

curl 请求示例

先在当前终端设置环境变量,再调用 Chat Completions。请把 <MODEL_ID> 替换为模型广场显示的模型标识。

export XIAMA_API_KEY="<XIAMA_API_KEY>"

curl https://api.xmapi.me/v1/chat/completions \
  -H "Authorization: Bearer $XIAMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<MODEL_ID>",
    "messages": [
      {"role": "user", "content": "用一句话介绍 API 网关"}
    ],
    "stream": false
  }'

Python SDK 示例

OpenAI Python SDK 可通过 base_url 指向兼容入口。以下代码从环境变量读取 Key。

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["XIAMA_API_KEY"],
    base_url="https://api.xmapi.me/v1",
)

response = client.chat.completions.create(
    model="<MODEL_ID>",
    messages=[
        {"role": "user", "content": "用一句话介绍 API 网关"}
    ],
)

print(response.choices[0].message.content)

模型切换与 Key 分组

一把 API Key 绑定一个分组。同一分组内,通常只需修改请求的 model 字段即可切换模型,不需要为每个模型单独创建 Key。

如果还要使用 Anthropic Messages 兼容接口,应为支持该协议的当前分组另建一把 Key,并按Messages 接入文档发送请求。

请求失败时

  • 401:检查是否使用 Bearer 鉴权、Key 是否完整且处于可用状态。
  • 400 或 404:检查请求体、端点和模型标识,确认模型属于 Key 所绑定的分组。
  • 403:检查账户余额,以及 Key、账户或分组的可用范围。
  • 429:检查 Key 额度或请求频率;以响应体给出的错误信息为准。
  • 5xx:保留响应中的 X-Request-ID、时间、模型与端点,稍后重试或提交工单。

查看完整排查与计费核对方法 →

不要在公开场合提交真实 Key。向客服反馈时只提供请求时间、模型、端点、HTTP 状态码、错误正文和请求 ID;如需标识 Key,可使用控制台中的 Key 名称或脱敏后的末尾字符。

文档维护:虾马AI · 最后更新:2026-08-03