PureBridge API 文档

面向技术开发者和重度用户的 OpenAI-compatible API 参考。这里保留接口、SDK、CLI、Agent 和错误处理细节。

API Key · 面向个人开发者和轻量项目。

如果你只是想直接聊天、写作或生成图片,请先阅读使用指南或打开 Chatbox。本页适合需要 API Key、Base URL、SDK、CLI、IDE Agent 和自动化接入的用户。

https://api.purebridge.uk

程序请求使用 API 域名;账号、API KEY 和账单在控制台管理。

Bearer API KEY

先在控制台创建 API KEY,再通过 Authorization 请求头调用 API。

OpenAI 风格 JSON

兼容 OpenAI SDK 风格的 base_url、Bearer 鉴权和 JSON 请求/响应结构。

聊天补全支持 stream: true 的流式返回;做响应头验证时建议临时使用 stream: false。

从注册到首个请求的最短路径。

创建账号、生成 API KEY,然后用标准 OpenAI SDK 配置 base_url。

  1. 创建 PureBridge 账号并登录控制台。
  2. 创建 API KEY,并根据需要设置额度和限速。
  3. 向 API 域名发送请求,并在 Authorization 头中带上 Bearer <your_key>。
  4. 建议先调用 GET /v1/models,再使用一个最小聊天请求调用 POST /v1/chat/completions。

当前公开能力面

PureBridge 对外保持小而明确的契约。下面是当前面向用户集成的已文档化路由。

GET /v1/models

获取可用模型

返回当前可用于调用的 PureBridge 模型 ID 列表。

POST /v1/chat/completions

创建聊天补全

支持流式

接收 OpenAI 风格的聊天请求体;支持 stream: true 的流式返回,也支持 stream: false 的普通 JSON 返回。

GET /health

健康检查

返回轻量级 OK 状态,适合部署探活和连通性检查。

POST /v1/chat/completions

聊天补全支持 stream: true 的流式返回;做响应头验证时建议临时使用 stream: false。

这里显示的是 GET /v1/models 返回的 PureBridge 模型 ID。调用时请按返回值原样使用;它们可能是路由别名,并不等同于上游供应商的官方发布名称。

curl https://api.purebridge.uk/v1/chat/completions \
  -H "Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "codex-auto-review",
  "messages": [
    {
      "role": "system",
      "content": "You are a concise assistant."
    },
    {
      "role": "user",
      "content": "Say hello from PureBridge."
    }
  ],
  "stream": true
}'

标准 SSE 流式返回结构

data: {"id":"chatcmpl_123","object":"chat.completion.chunk","model":"codex-auto-review","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl_123","object":"chat.completion.chunk","model":"codex-auto-review","choices":[{"index":0,"delta":{"content":"Hello from PureBridge."},"finish_reason":null}]}

data: {"id":"chatcmpl_123","object":"chat.completion.chunk","model":"codex-auto-review","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

核对 OpenAI 路由请求的官方 request id

当所选模型路由到 OpenAI 官方上游时,PureBridge 会透传 OpenAI 返回的 x-request-id。你也可以发送 X-Client-Request-Id,把自己的 trace id 带到上游排障链路中。

  • x-request-id 是 OpenAI API 为本次上游请求生成的请求 ID,适合 PureBridge 支持侧排障和对账。
  • X-Client-Request-Id 由你生成并随请求发送,便于把本地日志、PureBridge 用量记录和上游排障串起来。
  • 如果你的模型 ID 实际路由到非 OpenAI 上游,应以该上游自己的响应头和错误格式为准。
  • 示例里的 body sha256 是你本地发出字节的哈希;如果后续启用网关级 body-sha256 回显,可以进一步核对上游收到的字节。

响应头验证示例

export PB_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxx"
CLIENT_REQUEST_ID="pb-verify-$(date +%s)"
BODY='{"model":"codex-auto-review","messages":[{"role":"user","content":"ping"}],"stream":false}'

printf "%s" "$BODY" | shasum -a 256

curl -sS -D - -o /tmp/purebridge-verify.json https://api.purebridge.uk/v1/chat/completions \
  -H "Authorization: Bearer $PB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Client-Request-Id: $CLIENT_REQUEST_ID" \
  --data-binary "$BODY" \
  | grep -Ei '^(x-request-id|openai-|x-ratelimit|date):'

当前环境可用的 PureBridge 模型 ID

这里显示的是 GET /v1/models 返回的 PureBridge 模型 ID。调用时请按返回值原样使用;它们可能是路由别名,并不等同于上游供应商的官方发布名称。

  • codex-auto-review codex-auto-review ·
  • gpt-5.4-mini gpt-5.4-mini ·
  • gpt-5.5 gpt-5.5 ·

GET /v1/models 的响应结构

{
  "object": "list",
  "data": [
    {
      "id": "codex-auto-review",
      "object": "model",
      "owned_by": ""
    },
    {
      "id": "gpt-5.4-mini",
      "object": "model",
      "owned_by": ""
    },
    {
      "id": "gpt-5.5",
      "object": "model",
      "owned_by": ""
    }
  ]
}

生产接入前需要明确的行为预期。

保持实现简单:一个 API 域名、Bearer 鉴权、显式模型选择,以及标准 HTTP 错误处理。

鉴权与 API KEY

  • 每个 API 请求都需要发送 Authorization: Bearer <your_key>。
  • 账号级 API KEY 通过 PureBridge 控制台创建和轮换。
  • 不要把生产 API KEY 放在浏览器代码、公开仓库或客户端日志中。

错误与限流

  • 401 表示 Bearer API KEY 缺失、无效或已禁用。
  • 429 表示账号或当前环境触发限流,应使用退避重试。
  • 5xx 响应应按临时上游或路由故障处理。

API Key 用户推荐这样接入

API Key 的核心闭环是:购买或兑换套餐、创建 API KEY、把 PureBridge 配成 OpenAI-compatible Provider,并用用量页持续核对请求、Token 和费用。

  1. 在 API Key 工作台创建 API KEY。不同工具、项目或自动化任务建议使用不同 API KEY,便于单独停用、轮换和核算成本。
  2. Base URL 通常填写页面顶部显示的基础地址 + /v1;如果某个工具会自动拼接 /v1,则只填写基础地址。
  3. API KEY 使用 Authorization: Bearer <your_key>。不要把 API KEY 写入前端代码、公开仓库、截图或客户端日志。
  4. 模型 ID 以 GET /v1/models 返回值为准,不要把上游供应商的官方模型名直接当作 PureBridge 模型 ID。
  5. 交互式聊天建议开启 Streaming;排障或验证响应头时可临时使用 stream=false。
  6. Agent、Codex、工作流和长上下文任务会快速消耗 Token。建议为每个 API KEY 设置日/月预算、速率限制和通知邮箱。

把 PureBridge 当作 OpenAI-compatible Provider

大多数 CLI、IDE agent 和工作流工具只需要四项:Provider 选择 OpenAI Compatible 或 Custom OpenAI,Base URL 填 PureBridge /v1 地址,API KEY 填 API Key,Model 使用 /v1/models 返回的模型 ID。

Codex / opencode

适合在仓库里进行代码修改、解释、重构、测试和长任务自动化。

  • Codex 建议使用独立 CODEX_HOME,把 PureBridge 的 config.toml 和 auth.json 与其他上游隔离。
  • opencode 可配置自定义 provider;OpenAI-compatible chat-completions 形态使用 @ai-sdk/openai-compatible,并配置 baseURL、apiKey 和 models。
  • 这类工具上下文大、循环多,建议使用独立 API KEY,并设置每日预算和速率限制。

Aider

适合 Git 仓库内的小步修改、补测试、解释 diff 和提交前检查。

  • 优先选择支持 OpenAI-compatible base URL 的配置方式,填入 PureBridge /v1 地址和 API Key。
  • 从小上下文、小文件任务开始验证,再放开更大的仓库范围。
  • 把 Aider 单独使用一个 API KEY,便于从用量页区分编码消耗。

Continue

适合 VS Code / JetBrains 内的代码问答、补全、局部编辑和团队规则沉淀。

  • 在模型配置中选择 OpenAI-compatible 或自定义 OpenAI Provider。
  • 填写 Base URL、API KEY 和模型 ID;如工具分开配置 chat/edit/autocomplete,建议先只打开 chat。
  • IDE 常驻工具容易产生背景请求,建议单独设置限额。

Cline / Roo Code

适合需要读写文件、运行命令、调用浏览器或执行多步任务的本地 agent。

  • 选择 OpenAI Compatible / Custom Provider,填 PureBridge /v1、API KEY 和模型 ID。
  • 首次使用先关闭高风险自动批准项,确认文件和终端权限范围。
  • 长任务前设置 API KEY 级预算,避免循环调用导致异常消耗。

Dify / n8n / LiteLLM / 自写脚本

适合资料整理、消息摘要、日报生成、个人 Bot、定时任务和低代码自动化。

  • 使用 OpenAI-compatible 连接器,服务器端保存 API KEY,不在浏览器或移动端明文保存。
  • 不同工作流、环境和项目使用不同 API KEY,便于审计和熔断。
  • 先用 GET /v1/models 和一个最小聊天请求做连通性检查;需要看响应头时再临时使用 stream=false。

复制后替换 API KEY 和模型

下面示例会跟随当前站点 API 域名和模型列表生成。把 sk-xxxxxxxxxxxxxxxxxxxxxxxx 替换为你在 API Key 工作台创建的 API KEY。

环境变量

适合会从 Shell 读取 OpenAI-compatible 配置的 SDK、CLI 和 agent 工具。

export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxx"
export OPENAI_BASE_URL="https://api.purebridge.uk/v1"
export PUREBRIDGE_MODEL="codex-auto-review"

OpenAI Python SDK

把 base_url 指向 PureBridge,按 OpenAI-compatible Provider 使用。

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxx",
    base_url="https://api.purebridge.uk/v1",
)

response = client.chat.completions.create(
    model="codex-auto-review",
    messages=[{"role": "user", "content": "Say hello from PureBridge."}],
    stream=True,
)

通用 Agent 工具字段

适合提供 OpenAI-compatible 或 Custom OpenAI Provider 表单的工具。

Provider: OpenAI Compatible / Custom OpenAI
Base URL: https://api.purebridge.uk/v1
API Key: sk-xxxxxxxxxxxxxxxxxxxxxxxx
Model: codex-auto-review
Streaming: 交互式聊天开启;验证响应头时关闭

Codex 配置模式

如需和其他 Codex 上游隔离,建议使用独立 CODEX_HOME。

model_provider = "PureBridge"
model = "codex-auto-review"

[model_providers.PureBridge]
name = "PureBridge"
base_url = "https://api.purebridge.uk/v1"
wire_api = "responses"
requires_openai_auth = true

# auth.json
{"OPENAI_API_KEY":"sk-xxxxxxxxxxxxxxxxxxxxxxxx"}

opencode Provider 配置模式

opencode 的 OpenAI-compatible chat-completions Provider 可使用 AI SDK compatible 配置形态。

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "purebridge": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "PureBridge",
      "options": {
        "baseURL": "https://api.purebridge.uk/v1",
        "apiKey": "{env:OPENAI_API_KEY}"
      },
      "models": {
        "codex-auto-review": {
          "name": "codex-auto-review"
        }
      }
    }
  },
  "model": "purebridge/codex-auto-review"
}

这条路径适合什么

  • OpenAI-compatible API 调用:把 PureBridge 配到 SDK、CLI、IDE agent 或工作流工具里。
  • 开发者效率场景:Codex、opencode、Aider、Continue、Cline、Roo Code 等工具适合代码修改、解释、测试和自动化任务。
  • 个人自动化场景:日报、资料整理、消息摘要、内容生成、个人 Bot、定时脚本和低代码工作流。
  • 预算治理场景:按工具、项目或工作流拆分 API KEY,通过用量页跟踪请求、Token、费用和异常消耗。

阅读后怎么做

注册账号,在 App 工作区创建 API KEY,然后调用 API 域名。

当前行为约束