基础地址
https://api.purebridge.uk
程序请求使用 API 域名;账号、API KEY 和账单在控制台管理。
开发者入口
面向技术开发者和重度用户的 OpenAI-compatible API 参考。这里保留接口、SDK、CLI、Agent 和错误处理细节。
API Key · 面向个人开发者和轻量项目。
如果你只是想直接聊天、写作或生成图片,请先阅读使用指南或打开 Chatbox。本页适合需要 API Key、Base URL、SDK、CLI、IDE Agent 和自动化接入的用户。
基础地址
程序请求使用 API 域名;账号、API KEY 和账单在控制台管理。
鉴权方式
先在控制台创建 API KEY,再通过 Authorization 请求头调用 API。
兼容协议
兼容 OpenAI SDK 风格的 base_url、Bearer 鉴权和 JSON 请求/响应结构。
快速开始
创建账号、生成 API KEY,然后用标准 OpenAI SDK 配置 base_url。
接口清单
PureBridge 对外保持小而明确的契约。下面是当前面向用户集成的已文档化路由。
/v1/models
返回当前可用于调用的 PureBridge 模型 ID 列表。
/v1/chat/completions
支持流式
接收 OpenAI 风格的聊天请求体;支持 stream: true 的流式返回,也支持 stream: false 的普通 JSON 返回。
/health
返回轻量级 OK 状态,适合部署探活和连通性检查。
请求示例
聊天补全支持 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
}'
响应示例
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 官方上游时,PureBridge 会透传 OpenAI 返回的 x-request-id。你也可以发送 X-Client-Request-Id,把自己的 trace id 带到上游排障链路中。
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
登录后这里显示当前 API 套餐实际可用的模型 ID;未登录公共文档使用 MODEL_ID 占位符。调用时请按 GET /v1/models 返回值原样使用。
公共文档不会展示平台全量模型。登录 API Key 工作台后,可查看当前套餐模型;调用时请使用你的 API KEY 请求 GET /v1/models。
模型列表返回
{
"object": "list",
"data": []
}
接入细节
不同平台可能使用不同协议。API Key 工作台会按当前套餐生成 Codex、Claude Code、OpenCode、Gemini CLI 和 curl 的完整配置文本,用户复制后手动替换本地文件。
API KEY 使用说明
API Key 的核心闭环是:购买或兑换套餐、创建 API KEY、把 PureBridge 配成 OpenAI-compatible Provider,并用用量页持续核对请求、Token 和费用。
Agent 工具接入
请先在 API Key 工作台查看套餐可用模型,再按客户端实际协议配置。OpenAI Responses、Chat Completions、Anthropic Messages 和 Gemini 的端点、请求头与配置格式不同。
终端 Coding Agent
适合在仓库里进行代码修改、解释、重构、测试和长任务自动化。
命令行结对编程
适合 Git 仓库内的小步修改、补测试、解释 diff 和提交前检查。
IDE 助手
适合 VS Code / JetBrains 内的代码问答、补全、局部编辑和团队规则沉淀。
VS Code Agent
适合需要读写文件、运行命令、调用浏览器或执行多步任务的本地 agent。
自动化与工作流
适合资料整理、消息摘要、日报生成、个人 Bot、定时任务和低代码自动化。
配置片段
公共文档只提供占位示例。登录 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="YOUR_MODEL_ID"
把 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="YOUR_MODEL_ID",
messages=[{"role": "user", "content": "Say hello from PureBridge."}],
stream=True,
)
适合提供 OpenAI-compatible 或 Custom OpenAI Provider 表单的工具。
Provider: OpenAI Compatible / Custom OpenAI
Base URL: https://api.purebridge.uk/v1
API Key: sk-xxxxxxxxxxxxxxxxxxxxxxxx
Model: YOUR_MODEL_ID
Streaming: 交互式聊天开启;验证响应头时关闭
如需和其他 Codex 上游隔离,建议使用独立 CODEX_HOME。
model_provider = "PureBridge"
model = "YOUR_MODEL_ID"
[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 的 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": {
"YOUR_MODEL_ID": {
"name": "YOUR_MODEL_ID"
}
}
}
},
"model": "purebridge/YOUR_MODEL_ID"
}
Claude Code 使用 Anthropic Messages 协议,环境变量和 OpenAI Chat Completions 不同。登录工作台可按套餐模型生成完整文件。
export ANTHROPIC_BASE_URL="https://api.purebridge.uk"
export ANTHROPIC_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxx"
export ANTHROPIC_MODEL="YOUR_MODEL_ID"
OpenCode 必须在 models 中声明套餐模型;已声明的模型可在 /models 中切换。套餐新增模型后,请重新复制配置并手动替换文件。
协议:Responses / Chat Completions / Messages / Gemini
配置:由 API Key 工作台按当前套餐生成
边界:页面只提供文本,不会自动写入客户端
场景重点
下一步
注册账号,在 App 工作区创建 API KEY,然后调用 API 域名。
说明