跳转到内容

API 参考 ​

使用项目 API Key 调用 OpenAI-compatible Chat Completions 接口。控制台登录使用 cookie session,与模型调用的 Bearer 认证不同。

连接配置 ​

参数值
Base URLhttps://zeroclave.com/v1
Chat CompletionsPOST https://zeroclave.com/v1/chat/completions
AuthorizationBearer $ZEROCLAVE_API_KEY

项目专属接入信息、密钥管理和可用模型请登录控制台查询。本文不读取 session 或项目私有数据。设置环境变量 ZEROCLAVE_API_KEY 和 ZEROCLAVE_MODEL,后者使用控制台模型目录中的实际可用 ID。

请求参数 ​

参数说明
model必填,当前可用模型 ID。
messages必填,对话消息数组。
stream可选,true 启用 SSE。
max_tokens / max_completion_tokens可选,传入时必须是正整数,不能为 null 或 0。支持情况与上限以模型能力为准。
temperature, top_p, tools可选,支持情况和取值范围以模型能力为准。

调用示例 ​

bash
curl https://zeroclave.com/v1/chat/completions \
  -H "Authorization: Bearer $ZEROCLAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"<MODEL_ID>","messages":[{"role":"user","content":"Hello"}]}'
python
import os
from openai import OpenAI

client = OpenAI(
    base_url="https://zeroclave.com/v1",
    api_key=os.environ["ZEROCLAVE_API_KEY"],
    max_retries=0,
)
response = client.chat.completions.create(
    model=os.environ["ZEROCLAVE_MODEL"],
    messages=[{"role": "user", "content": "Hello"}],
)
print(response.choices[0].message.content)
js
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://zeroclave.com/v1',
  apiKey: process.env.ZEROCLAVE_API_KEY,
  maxRetries: 0,
});
const response = await client.chat.completions.create({
  model: process.env.ZEROCLAVE_MODEL,
  messages: [{ role: 'user', content: 'Hello' }],
});
console.log(response.choices[0].message.content);

curl 示例中的 <MODEL_ID> 需要手动替换。Python 安装 openai 包;Node.js 安装 openai 包。示例关闭 SDK 自动重试;请依据请求结果和业务副作用决定重试策略。

流式请求 ​

python
with client.chat.completions.create(
    model=os.environ["ZEROCLAVE_MODEL"],
    messages=[{"role": "user", "content": "Hello"}],
    stream=True,
) as stream:
    for chunk in stream:
        if chunk.choices:
            print(chunk.choices[0].delta.content or "", end="", flush=True)

该示例基于上面的 Python client。生成中途也可能失败,请阅读 Streaming 和 Errors.

模型与额度 ​

bash
curl https://zeroclave.com/v1/models -H "Authorization: Bearer $ZEROCLAVE_API_KEY"
curl https://zeroclave.com/v1/quota -H "Authorization: Bearer $ZEROCLAVE_API_KEY"

模型目录、功能与额度以当前项目和服务端配置为准。不要依赖 PDF 中的历史型号或价格。

限流与排障 ​

公共 402 表示 ZeroClave 账户或项目额度不足;429 表示 ZeroClave 调用方限流。模型服务错误使用 502/503/504 model_unavailable;不能将其理解为用户密钥无效或用户额度不足。HTTP 503 还可能携带 pii_mapping_saturated:应停止自动重试,携带 X-Request-ID 联系管理员或平台支持;此容量错误不附带 Retry-After。普通限流时遵循可用的 Retry-After,它是响应头,不是 JSON 包体字段。详见错误代码。

隐私边界 ​

隐私识别可能存在漏检。图片、视觉输入和原始文件不属于文本 PII 脱敏保证;请先确认客户端实际发送的数据类型。

标准 API 接入通过 HTTPS 传输。修改服务地址和 API Key 不等于启用端到端加密或严格远程证明。

完整保护边界 · 用户协议