Skip to content

API 概览

Base URL

text
https://relay.withrpm.org/v1

大多数 OpenAI SDK 接受自定义 base_url,因此通常只需修改 Base URL、API Key 和模型 ID。

认证

http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

常用端点

方法路径用途
GET/v1/models查询当前密钥可用的模型
POST/v1/chat/completionsChat Completions 格式的对话请求
POST/v1/responsesResponses 格式的生成请求;是否可用取决于所选模型与渠道
POST/v1/images/generations生成图片;输入与输出能力取决于所选模型与渠道
POST/v1/videos提交异步视频生成任务
GET/v1/videos/{video_id}查询视频任务状态
GET/v1/videos/{video_id}/content下载已完成的视频

响应与请求 ID

成功响应使用相应 OpenAI-compatible 结构。失败时保留完整响应体和响应头,尤其是请求 ID;它能帮助管理员在日志中定位请求。

流式输出

支持流式能力的端点可在请求中传入:

json
{ "stream": true }

客户端必须按 Server-Sent Events(SSE)逐条消费数据,而不是等待整个响应结束。具体能力取决于模型与渠道;接入前请先用非流式请求完成验证。

兼容性边界

“OpenAI-compatible”表示核心请求和响应格式兼容,并不意味着每个上游模型都支持所有字段。遇到差异时:

  1. 先调用 /v1/models 确认模型 ID。
  2. 用最小请求移除可选字段后重试。
  3. 查看常见错误和控制台日志。

OpenAI-compatible API gateway