リファレンス

ドキュメント。

Zylooでリリースするために必要なすべて — 最初のリクエストから、本番品質のルーティングと可観測性まで。

ステップ1

クイックスタート

ZylooはOpenAI APIをそのまま話します。あなたのコードが次と通信しているなら api.openai.com、ベースURLを当社のものに向けるだけで完了です。

ベースURL

エージェント型CLI — Claude Code、opencodeなど — は次を指します https://api.zyloo.io。OpenAI形式のクライアントやCursorのようなエディタは次を使います https://api.zyloo.io/v1

bash
# 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のキーを入れ、いつも通り実行してください。

bash
# 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
連携

5大コーディングCLIをZylooで

人気のターミナルエージェントはすべてOpenAIまたはAnthropic形式で通信するため、Zylooのキーひとつで動きます。使っているツールのブロックをコピーして、価格一覧の任意のモデルを指定してください。

Claude Code · Anthropic

Anthropicのターミナルエージェント。Anthropic形式の環境変数をゲートウェイに向けるだけ。

bash
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

claude
Codex CLI · OpenAI

OpenAIのオープンソースCLI。config.tomlにZylooをプロバイダーとして登録。

bash
npm install -g @openai/codex
export ZYLOO_KEY=sk-zy-...
toml
# ~/.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 · open source

モデル非依存のオープンソース定番。opencode.jsonにZylooをカスタムプロバイダーとして追加。

bash
npm install -g opencode-ai
export ZYLOO_KEY=sk-zy-...
json
// 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": {}
      }
    }
  }
}
aider
Aider · open source

git連携のペアプログラマー。標準のOpenAI互換環境変数を使用。

bash
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
Qwen Code · Alibaba

Alibabaのコーディングエージェント。OPENAI_*変数を読むだけで設定完了。

bash
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。キーはプロジェクトごとにスコープされ、ダッシュボードから即座に失効できます。

http
Authorization: Bearer sk-zy-9f3a0e5b...

ローカル開発では、キーを次のファイルに保存することを推奨します .env。ランタイム経由で読み込んでください — キーをソース管理にコミットしないこと。

カタログ

モデル

任意のモデルを正規のZyloo IDで参照できます。すべてのIDは次の名前空間下にあり zyloo/... プロバイダー間で曖昧さがありません。全102モデルの一覧は次にあります モデルページ

bash
# 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.3
bash
curl https://api.zyloo.io/v1/models \
  -H "Authorization: Bearer $ZYLOO_KEY"
ヒント

拡張推論を持つモデルは次で終わります -thinking — 例えば zyloo/claude-opus-4-7-thinking または zyloo/gpt-5.5-xhigh

エンドポイント

チャット補完

OpenAIと同じJSON形状です /v1/chat/completions。ツール、JSONモード、ビジョン、構造化出力は、すべての互換モデルでサポートされています。

ts
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と同じです。画像モデルはトークンではなく画像ごとに課金され、モデルページには画像単価が表示されます。

ts
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);
bash
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 を返します。

bash
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と同じデルタ形式のServer-Sent Eventsを受け取れます。

ts
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で自動リトライ

リリースの準備はできましたか?

キーを取得して、1分以内にトラフィックの送信を始めましょう。

APIキーを取得