PureBridge.uk
中文
中文 English 한국어 Русский فارسی

开发者入口

PureBridge API 文档

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

企业 / 组织 · 面向需要销售对接和人工配置的团队。

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

返回使用指南 打开 Chatbox

基础地址

https://api.purebridge.uk

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

鉴权方式

Bearer API KEY

先在 PureBridge App 工作区创建 API KEY，再通过 Authorization 请求头传入。

兼容协议

OpenAI 风格 JSON

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

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

创建账号 切换到企业定制

快速开始

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

现在的公开用户路径已经收敛：先在主域名注册登录，再进 App 生成 API KEY，最后调用 API 域名。

  1. 在 purebridge.uk 创建账号并登录。
  2. 进入 App 工作区，创建一个 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。

登录后这里显示当前 API 套餐实际可用的模型 ID；未登录公共文档使用 MODEL_ID 占位符。调用时请按 GET /v1/models 返回值原样使用。

curl https://api.purebridge.uk/v1/chat/completions \
  -H "Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "YOUR_MODEL_ID",
  "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":"YOUR_MODEL_ID","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

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

data: {"id":"chatcmpl_123","object":"chat.completion.chunk","model":"YOUR_MODEL_ID","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 回显，可以进一步核对上游收到的字节。

verify.sh

响应头验证示例

export PB_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxx"
CLIENT_REQUEST_ID="pb-verify-$(date +%s)"
BODY='{"model":"YOUR_MODEL_ID","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):'

已启用模型 ID

当前环境可用的 PureBridge 模型 ID

登录后这里显示当前 API 套餐实际可用的模型 ID；未登录公共文档使用 MODEL_ID 占位符。调用时请按 GET /v1/models 返回值原样使用。

公共文档不会展示平台全量模型。登录 API Key 工作台后，可查看当前套餐模型；调用时请使用你的 API KEY 请求 GET /v1/models。

模型列表返回

GET /v1/models 的响应结构

{
  "object": "list",
  "data": []
}

接入细节

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

不同平台可能使用不同协议。API Key 工作台会按当前套餐生成 Codex、Claude Code、OpenCode、Gemini CLI 和 curl 的完整配置文本，用户复制后手动替换本地文件。

鉴权与 API KEY

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

错误与限流

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

场景重点

这条路径适合什么

  • 团队接入和账号支持
  • 人工配置与销售联系
  • 用量评估、SLA 和账号管理

下一步

阅读后怎么做

提交联系表单，我们会根据需求评估并跟进。

说明

当前行为约束