首页 / API 文档 / OpenAI 兼容 API

INTEGRATION GUIDE

OpenAI 兼容 API:快速接入

将现有客户端的 Base URL 指向 API Rove,并通过服务端 API Key 调用账户可用的 GPT 或 Grok 模型。

指南 · AI API 集成 · 约 4 分钟阅读

开始前

  1. 登录控制台,确认账户余额、模型权限与模型 ID。
  2. 创建一个专用 API Key,并仅保存在应用服务端。
  3. 确认你选的模型支持 Responses API 或 Chat Completions。

API Base URL:https://apirove.com/v1

Responses API 请求示例

以下示例适用于账户中支持 Responses 格式的模型。将占位符替换成自己的密钥和模型 ID。

export APIROVE_API_KEY='YOUR_API_KEY'
export APIROVE_MODEL='YOUR_MODEL_ID'

curl https://apirove.com/v1/responses \\
  -H "Authorization: Bearer $APIROVE_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{"model":"'"$APIROVE_MODEL"'","input":"Hello!","max_output_tokens":64}'

Chat Completions 请求示例

如果模型详情标注支持 Chat Completions,可使用以下接口:

curl https://apirove.com/v1/chat/completions \\
  -H "Authorization: Bearer $APIROVE_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{"model":"'"$APIROVE_MODEL"'","messages":[{"role":"user","content":"Hello!"}],"max_tokens":64}'

在 OpenAI SDK 中设置 Base URL

常见 OpenAI SDK 通常允许自定义 Base URL。下例展示 Python 的配置形式;SDK 方法和模型接口需要匹配实际模型支持范围。

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://apirove.com/v1",
)

response = client.responses.create(
    model="YOUR_MODEL_ID",
    input="Hello!",
    max_output_tokens=64,
)
print(response.output_text)

常见问题

  • 401:确认密钥正确,并按 Bearer 格式传递。
  • 模型不可用:确认模型 ID 拼写、账户分组权限与模型开放状态。
  • 参数错误:使用所选接口对应的参数名;Responses 与 Chat Completions 并非所有字段通用。
  • 费用不同:以登录账户展示的模型计价和用量明细为准。
密钥不要放在网页前端、公开仓库或客户端应用包中。更多建议见API Key 安全指南。