aai-repeater
DEVELOPER DOCUMENTATION

OpenAI 兼容 API

使用 OpenAI 官方 SDK 或 HTTP 客户端接入,支持普通请求与流式响应。本文档无需登录即可阅读。

快速接入

Base URL

未登录时,示例使用 ${YOUR_API_KEY};登录后自动填入本人的当前 API Key。

请求头使用 Authorization: Bearer API_KEY。生成接口同时发送 Content-Type: application/json。不要在 Base URL 后重复添加 /v1。

接口说明

方法路径作用 / 主要字段
GET/v1/models查询当前可用的对外模型,返回 object=list 和 data 数组。
GET/v1/models/{model}查询单个可用模型,返回 id、object、created、owned_by。
POST/v1/chat/completionsmodel、messages;stream=true 开启流式。普通响应读取 choices[].message。
POST/v1/responsesmodel、input;store=false;stream=true 开启流式。普通响应读取 output。

两种生成接口均保留渠道返回的模型名称。tools、工具参数、结构化输出及采样参数随请求转发,具体支持由所选渠道模型决定。不要把工具结果、推理文本或缓存细分再次累加到总 token 中。

查询模型

调用示例

流式响应

请求体设置 stream: true,响应类型为 text/event-stream。cURL 使用 -N,代理服务器应关闭缓冲。

Chat Completions

逐个读取 data 事件中的 choices[].delta;工具调用读取 tool_calls 的增量参数。结束标志为 data: [DONE]。网关要求最终 usage 统计块用于结算,该块 choices 为空,SDK 循环需先检查 choices。

Responses

按事件 type 分发,常用 response.output_text.delta、response.completed、response.failed、response.incomplete 与 error。错误事件含 code、message、param 和 sequence_number。不要用 Chat 的 [DONE] 逻辑判断 Responses 完成。

连接中断后不会伪造成功完成,也不会自动换渠道继续生成。客户端需要处理流内错误或 SDK 异常;收到 HTTP 200 只代表流已建立。断流可能缺失最终 usage。

错误与计费

{
  "error": {
    "message": "The requested model does not exist.",
    "type": "invalid_request_error",
    "code": "model_not_found",
    "param": "model"
  }
}
状态码说明
400请求参数有误,或使用了当前未支持的参数。
401Key 无效、停用,或用户已冻结。
402可用余额不足,或先前请求仍待用量核对。这是本站扩展状态。
404模型或接口不存在。
429渠道返回限流,或网关总体并发已满。
502 / 503 / 504渠道异常、没有可用渠道或请求超时。

渠道 HTTP 错误保留脱敏的 message、code、param;请保留响应头 X-Request-Id 以便查询调用记录。生成请求不自动重试;SDK 示例设为 max_retries=0,避免未知结果被重复提交。

费用 =(实际输入 token + 实际输出 token)÷ 1,000,000 × 当次渠道映射的美元单价。请求会先预留预算,最终按实际 usage 结算;超时、断流或缺失用量时可能保留预留等待核对,并不代表已按估算扣费。

兼容范围

当前提供 OpenAI 文本生成协议的一个明确子集,并非 OpenAI 全部 API 的完整实现。

  • 已提供模型列表、单模型查询,以及 Chat Completions / Responses 的普通和流式转发。
  • Responses 当前仅支持无状态调用,显式使用 store=false;previous_response_id、conversation、store=true、background=true 暂不支持。
  • Files、Batch、Realtime、Conversations、持久响应查询、图片生成、音频与 Embeddings 尚未开放。
  • Anthropic 协议适配尚未开放。真实渠道及模型是否支持特定参数,需要供应商具备相应能力。
  • 渠道响应按协议转发;自建渠道的实际能力与响应质量由渠道决定。官方 SDK 模拟验证不等于真实 OpenAI 账号联通验证。

官方参考:Chat Completions · Responses 事件 · Models