▪ getting started
概览与快速开始
11book 提供 OpenAI 兼容协议:OpenAI SDK 与其他兼容客户端只需替换 Base URL 和 API Key 即可接入。
三步接入
- 注册并充值——创建账号并充值美元余额,无月费、无订阅、无最低消费。
- 创建 API Key——在控制台一键生成 sk- 开头的密钥,可单独设置额度上限与有效期。
- 配置接入地址与模型——把 SDK 或客户端的 Base URL 指向 11book,填入新建的 Key,并从模型目录复制完整模型 ID。
Base URL 与认证
所有请求发往 https://api.11book.ai/v1,并以 Authorization: Bearer 头携带你的 API Key:
终端
export BOOK_API_KEY="sk-xxxx" # console → API Keys发起第一个请求
安装 OpenAI 官方 Python SDK 后,填入 11book 的 Base URL、API Key 和完整模型 ID:
main.py
import os
from openai import OpenAI
client = OpenAI(
api_key=os.environ["BOOK_API_KEY"],
base_url="https://api.11book.ai/v1",
)
resp = client.chat.completions.create(
model="YOUR_MODEL_ID",
messages=[{"role": "user", "content": "Hello"}],
)
print(resp.choices[0].message.content)偏好纯 HTTP 时,直接调用 Chat Completions 端点:
终端
curl https://api.11book.ai/v1/chat/completions \
-H "Authorization: Bearer $BOOK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "YOUR_MODEL_ID",
"messages": [{"role": "user", "content": "Hello"}]
}'按量付费,充值额度永久有效。价格表直接展示实付单价,输入、缓存读取与输出费用分别列出,无需自行换算。
上线前检查
- 按应用、环境和成员分别创建 API Key,不要多人共用一把生产密钥。
- 在控制台为密钥设置额度上限或有效期,再交给服务使用。
- 先发起一个小请求,确认模型、余额和使用记录都符合预期。
- 限制重试次数;无效密钥或余额不足无法靠无限重试解决。
支持的协议
- Chat Completions(
/v1/chat/completions)——用于对话补全;参数、工具调用与流式能力取决于所选模型。 - Responses(
/v1/responses)——新一代协议,Codex CLI 与 Agent 场景默认使用。
可用模型
在模型与价格中选择可用模型,将示例中的 YOUR_MODEL_ID 替换为完整模型 ID;调用前确认端点支持和使用限制。
当前模型报价见模型价格页;更多模型接入后陆续上架。