开发者文档

快速开始

Plenum Cloud 提供 OpenAI 兼容接口。已有 OpenAI SDK 的项目只需改 base_url 和 API Key 两行即可迁移。

1. 注册账户并在控制台「API Keys」创建密钥（明文仅显示一次）。2. 把 base_url 指向 Plenum。3. 照常调用。

from openai import OpenAI

client = OpenAI(
    base_url="https://api.plenumcloud.com/v1",
    api_key="pln-...",
)

stream = client.chat.completions.create(
    model="deepseek-v3.2",
    messages=[{"role": "user", "content": "你好，Plenum"}],
    stream=True,
)
for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

接口

鉴权

所有 /v1 请求使用 Authorization: Bearer <API Key>。密钥以 pln- 开头，吊销即时生效。

流式响应

设置 stream: true 即可。网关会自动注入 stream_options.include_usage，确保最后一个 SSE 块带有 usage——这是计量的依据，无需你手动设置。

计量与 usage 字段

每次请求按四类 token 分别计量、分别计价。它们出现在响应的 usage 对象里：

控制台「用量」与「账单」按同一口径展示，并可按模型、按密钥下钻；账单以平台计量为准。

前缀缓存

命中前缀缓存的输入 token 边际成本远低于未命中，我们把这部分让利体现在单价里。Agent 场景（长系统提示词、工具定义、多轮历史）天然高命中，前提是前缀字节级稳定：

命中率可在控制台按密钥观测。

限流与配额

每把 API Key 有独立的每分钟请求上限（令牌桶，允许短突发）和可选的月度 token 配额。超限返回 429，body 中 error.code 区分原因；建议客户端按指数退避重试。专属端点的限额以合同为准。

错误码

错误响应为 OpenAI 风格：{ "error": { "code", "message" } }。

4xx 错误不会重试；连接失败、5xx 与上游 429 会在候选上游间自动转移。

专属端点

专属端点是独占的推理容量：你的请求只路由到为你绑定的节点，不与其他客户共享，也不受公共池限流影响；按「容量 × 时间」计费，与实际 token 用量无关。

算力接入

有闲置 GPU 的团队可以把集群挂到平台出租。要求：节点提供 OpenAI 兼容的流式 chat completions 端点（vLLM / SGLang 等均可），可从公网或专线访问。

控制台 API

控制台使用的管理接口位于 /admin/v1，以登录会话 token 鉴权（Authorization: Bearer <session>），与 API Key 分离。可用于自动化查询用量与账单：