APIrove

首页 / API 文档 / OpenAI 兼容 API

INTEGRATION GUIDE

OpenAI 兼容 API:快速接入

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

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

开始前

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

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

cURL:Responses API 请求示例

cURL 请求格式已在低额度测试中验证。以下示例适用于账户中支持 Responses 格式的模型。先在终端设置环境变量,避免将密钥写进代码:

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":16}'

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":16}'

接收流式响应

流式响应会分段返回结果。下面以 Responses API 为例;使用前仍需确认所选模型和账户支持该接口:

curl -N https://apirove.com/v1/responses \
  -H "Authorization: Bearer $APIROVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"'"$APIROVE_MODEL"'","input":"用一句话解释什么是 API。","stream":true,"max_output_tokens":16}'

命令行会显示服务器发送的事件流。应用集成时应按 SSE 事件逐段读取,并在收到完成事件后结束;断线重试前先确认上一次请求是否已计费,避免重复提交。

Python OpenAI SDK 配置

常见 OpenAI SDK 通常允许自定义 Base URL。将密钥放在环境变量中,再通过 SDK 设置 APIrove 的 Base URL。此示例使用 Responses API:

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["APIROVE_API_KEY"],
    base_url="https://apirove.com/v1",
)

response = client.responses.create(
    model=os.environ["APIROVE_MODEL"],
    input="Hello!",
    max_output_tokens=16,
)
print(response.output_text)

不同 OpenAI SDK 版本支持的接口可能不同。如果客户端或模型不支持 Responses API,请使用已确认兼容的 Chat Completions 接口。

常见问题

  • 401:确认密钥正确、未撤销,并按 Bearer 格式传递。
  • 403:检查账户状态、模型权限,以及该模型是否支持所用接口。
  • 429:降低请求频率并查看账户额度或并发限制;不要立即高频重试。
  • 5xx:记录响应中的 request ID(如有),稍后重试前确认请求是否已完成及是否产生用量。
  • 费用不同:以登录账户展示的模型价格和用量明细为准。
API Key 只能保存在服务端环境变量或密钥管理器中,不要放进浏览器前端、公开仓库、移动端安装包或日志。更多建议见API Key 安全指南。