快速开始
Zyloo 逐字兼容 OpenAI API。如果你的代码对接 api.openai.com,把它重定向到我们的基础 URL 就完成了。
智能体 CLI——Claude Code、opencode 之类——指向 https://api.zyloo.io。OpenAI 风格的客户端和编辑器(如 Cursor)使用 https://api.zyloo.io/v1。
# 1. Install the official SDK (any language)
npm install openai
# 2. Get your key from https://zyloo.io/dashboard
export ZYLOO_KEY=sk-zy-...
# 3. Make your first call
curl https://api.zyloo.io/v1/chat/completions \
-H "Authorization: Bearer $ZYLOO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "zyloo/claude-opus-4-7",
"messages": [{"role": "user", "content": "Hello"}]
}'使用智能体编码 CLI?把它的基础 URL 设为 https://api.zyloo.io 和你的 Zyloo 密钥,然后照常运行。
# Claude Code, opencode, and other agentic CLIs
export ANTHROPIC_BASE_URL=https://api.zyloo.io
export ANTHROPIC_API_KEY=$ZYLOO_KEY
# Cursor and other OpenAI-compatible editors
# Base URL: https://api.zyloo.io/v1
# API key: $ZYLOO_KEY五大编程 CLI 均可接入 Zyloo
主流终端编程代理都使用 OpenAI 或 Anthropic 协议,因此一个 Zyloo 密钥全部通用——复制你工具对应的配置块,替换成价格页上的任意模型即可。
Anthropic 的终端代理。把 Anthropic 格式的环境变量指向网关即可。
npm install -g @anthropic-ai/claude-code
export ANTHROPIC_BASE_URL=https://api.zyloo.io
export ANTHROPIC_API_KEY=$ZYLOO_KEY
export ANTHROPIC_MODEL=zyloo/claude-opus-4-7-thinking
claudeOpenAI 的开源 CLI。在 config.toml 中把 Zyloo 注册为提供商。
npm install -g @openai/codex
export ZYLOO_KEY=sk-zy-...# ~/.codex/config.toml
model = "zyloo/gpt-5.5"
model_provider = "zyloo"
[model_providers.zyloo]
name = "Zyloo"
base_url = "https://api.zyloo.io/v1"
env_key = "ZYLOO_KEY"
wire_api = "chat"模型无关的开源热门工具。在 opencode.json 中添加 Zyloo 自定义提供商。
npm install -g opencode-ai
export ZYLOO_KEY=sk-zy-...// opencode.json
{
"$schema": "https://opencode.ai/config.json",
"provider": {
"zyloo": {
"npm": "@ai-sdk/openai-compatible",
"name": "Zyloo",
"options": {
"baseURL": "https://api.zyloo.io/v1",
"apiKey": "{env:ZYLOO_KEY}"
},
"models": {
"zyloo/claude-opus-4-7": {},
"zyloo/gpt-5.5": {}
}
}
}
}git 原生结对编程工具。使用标准 OpenAI 兼容环境变量。
python -m pip install aider-install && aider-install
export OPENAI_API_BASE=https://api.zyloo.io/v1
export OPENAI_API_KEY=$ZYLOO_KEY
aider --model openai/zyloo/claude-opus-4-7阿里巴巴的编程代理。直接读取 OPENAI_* 变量,无需额外配置。
npm install -g @qwen-code/qwen-code
export OPENAI_BASE_URL=https://api.zyloo.io/v1
export OPENAI_API_KEY=$ZYLOO_KEY
export OPENAI_MODEL=zyloo/deepseek-v4-pro
qwen身份验证
每个请求都必须在 Authorization 头中包含 bearer 令牌。密钥按项目划分范围,可从控制台即时吊销。
Authorization: Bearer sk-zy-9f3a0e5b...本地开发我们建议把密钥存放在 .env 文件中并通过运行时加载——切勿将密钥提交到源码管理。
模型
用任意模型的规范 Zyloo id 引用它。每个 id 都以 zyloo/... 为命名空间,因此在各提供商间不会有歧义。完整的 97 个模型列表见 模型页面。
# A few examples — see /dashboard/models for the full list
zyloo/claude-opus-4-7-thinking
zyloo/claude-opus-4-7
zyloo/gpt-5.5
zyloo/gemini-3.5-flash
zyloo/deepseek-v4-pro
zyloo/grok-4.3curl https://api.zyloo.io/v1/models \
-H "Authorization: Bearer $ZYLOO_KEY"具备扩展推理的模型以 -thinking 结尾——例如 zyloo/claude-opus-4-7-thinking 或 zyloo/gpt-5.5-xhigh。
聊天补全
与 OpenAI 的 /v1/chat/completions 相同的 JSON 结构。每个兼容模型都支持工具、JSON 模式、视觉和结构化输出。
import OpenAI from "openai";
const zyloo = new OpenAI({
apiKey: process.env.ZYLOO_KEY,
baseURL: "https://api.zyloo.io/v1",
});
const res = await zyloo.chat.completions.create({
model: "zyloo/gemini-3.5-flash",
messages: [
{ role: "system", content: "You are concise." },
{ role: "user", content: "Summarize this PR..." },
],
temperature: 0.2,
max_tokens: 512,
});
console.log(res.choices[0].message.content);图像生成
图像模型通过 /v1/images/generations 端点根据文本提示词生成图片——请求和响应结构与 OpenAI 的 Images API 相同。图像模型按图像计费,而非按 Token,并会以每张图像的价格显示在模型页面上。
const image = await zyloo.images.generate({
model: "zyloo/your-image-model", // any model marked "Image" on /models
prompt: "A watercolor lighthouse at dawn",
n: 1, // 1–4 images per request
size: "1024x1024",
});
console.log(image.data[0].url ?? image.data[0].b64_json);curl https://api.zyloo.io/v1/images/generations \
-H "Authorization: Bearer $ZYLOO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "zyloo/your-image-model",
"prompt": "A watercolor lighthouse at dawn",
"n": 1
}'- 每个请求按 每张图像价格 × 实际交付的图像数量 收费。`n` 用于选择生成多少张图像(1–4,默认 1)。
- 只对实际交付的图像收费:如果提供商失败、超时或返回错误,预扣金额会自动退回你的余额。
标记为支持编辑的模型还接受 POST /v1/images/edits 请求,使用 multipart 表单体(源图像 + 提示词),按相同的每张图像价格计费。未带该标记的模型在该端点会返回 400。
curl https://api.zyloo.io/v1/images/edits \
-H "Authorization: Bearer $ZYLOO_KEY" \
-F "model=zyloo/your-image-model" \
-F "image=@photo.png" \
-F "prompt=Add a red scarf" \
-F "n=1"流式传输
传入 stream: true 即可接收与 OpenAI 相同 delta 格式的 Server-Sent Events。
const stream = await zyloo.chat.completions.create({
model: "zyloo/claude-opus-4-7",
stream: true,
messages: [{ role: "user", content: "Tell me a story" }],
});
for await (const chunk of stream) {
process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
}错误
Zyloo 返回兼容 OpenAI 的错误对象。常见代码:
| 代码 | 含义 | 操作 |
|---|---|---|
| 401 | 密钥无效 | 从控制台轮换 |
| 402 | 额度不足 | 为钱包充值 |
| 429 | 已限流 | 退避,我们会路由到同类提供商 |
| 5xx | 上游故障 | 用 idempotency-key 自动重试 |