OpenElf开放精灵
下载 App

开发 / DOCS

Open API 接口

Base URL https://api.openelfai.com，OpenAI 兼容，Bearer 鉴权。对话补全接口为 POST /v1/chat/completions，请求体上限 4MB。

OpenElf 的 Open API 与 OpenAI Chat Completions 兼容：把 base_url 指向 OpenElf，换成 OpenElf 的 API Key，即可用现有 OpenAI SDK 或客户端调用。

基本信息

项目值
Base URLhttps://api.openelfai.com
接口POST /v1/chat/completions
兼容性OpenAI 兼容
鉴权Bearer 鉴权：Authorization: Bearer <API Key>
请求体上限4MB

请求参数

参数说明
model要调用的模型 ID。
messages对话消息数组，按 OpenAI 格式传入。
streamtrue 为流式返回，false 或省略为非流式返回。
tools可选，工具定义列表。
tool_choice可选，工具选择策略。
top_p可选，采样参数。

请求示例

curlShell
curl https://api.openelfai.com/v1/chat/completions \
  -H "Authorization: Bearer oe-sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek/deepseek-chat",
    "messages": [
      {"role": "user", "content": "用一句话介绍 OpenElf"}
    ],
    "stream": false,
    "top_p": 0.9
  }'
request bodyJSON
{
  "model": "deepseek/deepseek-chat",
  "messages": [{ "role": "user", "content": "查一下上海今天的天气" }],
  "stream": true,
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "查询指定城市天气",
        "parameters": {
          "type": "object",
          "properties": { "city": { "type": "string" } },
          "required": ["city"]
        }
      }
    }
  ],
  "tool_choice": "auto",
  "top_p": 0.9
}

流式与非流式

stream: true 时以流式方式逐段返回结果；stream: false 或省略时一次性返回完整响应。两种模式都使用同一个接口与同一把 Key。

可用模型

可用模型以 platform_model_catalog 中已登记且配置价格的模型为准。未登记或未配置价格的模型不可调用。

错误码

状态码含义
401未通过鉴权：API Key 缺失或无效。
402余额不足：该 AI 持有者的人民币钱包余额不足以支付本次调用。
404资源不存在：接口路径错误，或请求的模型不可用。
413请求体超过 4MB 上限。
429请求过于频繁，触发限流。
请把 API Key 保存在服务端，不要写入前端代码或公开仓库。

相关文档