开发者文档与接入规范

# macOS / Linux / WSL
curl -fsSL https://openclaw.ai/install.sh | bash

# 初始化并安装后台服务
openclaw onboard --install-daemon

# 检查 Gateway
openclaw gateway status

# 打开控制台
openclaw dashboard

~/.openclaw/
├── openclaw.json
└── agents/main/agent/auth-profiles.json

{
  "version": 1,
  "profiles": {
    "anthropic:default": {
      "type": "api_key",
      "provider": "anthropic",
      "key": "sk-your-api-key"
    }
  },
  "lastGood": {
    "anthropic": "anthropic:default"
  }
}

{
  "agents": {
    "defaults": {
      "model": {
        "primary": "anthropic/claude-sonnet-4-6"
      }
    }
  },
  "models": {
    "mode": "merge",
    "providers": {
      "anthropic": {
        "baseUrl": "https://api.yunjunet.cn",
        "models": []
      }
    }
  }
}

openclaw onboard --auth-choice apiKey --anthropic-api-key sk-your-api-key

# OpenAI 兼容格式（适用于大多数客户端）
API Base URL: https://api.yunjunet.cn/v1
API Key:      sk-your-api-key

# Anthropic 格式（Claude Code CLI / Cline / LobeChat Anthropic 模式）
API Base URL: https://api.yunjunet.cn
API Key:      sk-your-api-key

# Gemini 格式（Gemini CLI）
Base URL:     https://api.yunjunet.cn/v1beta/
API Key:      sk-your-api-key

# OpenAI 格式（适用于 /v1/chat/completions）
Authorization: Bearer sk-your-api-key

# Anthropic 格式（适用于 /v1/messages）
x-api-key: sk-your-api-key

# Gemini 格式（适用于 /v1beta/models/*）
x-goog-api-key: sk-your-api-key

{
  "agents": {
    "defaults": {
      "model": {
        "primary": "anthropic/claude-sonnet-4-6"
      }
    }
  },
  "models": {
    "mode": "merge",
    "providers": {
      "anthropic": {
        "baseUrl": "https://api.yunjunet.cn",
        "models": []
      }
    }
  }
}

pip install openai

from openai import OpenAI

client = OpenAI(
    base_url="https://api.yunjunet.cn/v1",
    api_key="sk-your-api-key"
)

resp = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "你好"}]
)
print(resp.choices[0].message.content)

import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.yunjunet.cn/v1',
  apiKey: 'sk-your-api-key',
});

const completion = await client.chat.completions.create({
  model: 'deepseek-chat',
  messages: [{ role: 'user', content: '你好' }],
});
console.log(completion.choices[0].message.content);

curl https://api.yunjunet.cn/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "model": "gpt-4o-mini",
  "choices": [{
    "index": 0,
    "message": { "role": "assistant", "content": "你好！" },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 5,
    "total_tokens": 15
  }
}

curl https://api.yunjunet.cn/v1/messages \
  -H "Content-Type: application/json" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-haiku-4-5",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

{
  "id": "msg_01XFDUDYJgAACzvnp...",
  "type": "message",
  "role": "assistant",
  "model": "claude-haiku-4-5",
  "content": [
    { "type": "text", "text": "Hello! How can I help you today?" }
  ],
  "stop_reason": "end_turn",
  "usage": {
    "input_tokens": 10,
    "output_tokens": 12
  }
}

event: message_start
data: {"type":"message_start","message":{"id":"msg_...","type":"message","role":"assistant","model":"claude-haiku-4-5","content":[],"usage":{"input_tokens":10,"output_tokens":0}}}

event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"text","text":""}}

event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"Hello"}}

event: content_block_stop
data: {"type":"content_block_stop","index":0}

event: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"end_turn"},"usage":{"output_tokens":12}}

event: message_stop
data: {"type":"message_stop"}

curl https://api.yunjunet.cn/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "claude-sonnet-4-6",
    "input": "Hello!",
    "max_output_tokens": 1024
  }'

{
  "model": "claude-sonnet-4-6",
  "instructions": "You are a helpful assistant",
  "input": [
    {"type": "message", "role": "user", "content": "What is 2+2?"},
    {"type": "message", "role": "assistant", "content": [
      {"type": "output_text", "text": "4"}
    ]},
    {"type": "message", "role": "user", "content": "And 3+3?"}
  ]
}

{
  "id": "resp_xxx",
  "object": "response",
  "created_at": 1234567890,
  "status": "completed",
  "model": "claude-sonnet-4-6",
  "output": [{
    "type": "message",
    "id": "msg_xxx",
    "role": "assistant",
    "status": "completed",
    "content": [{"type": "output_text", "text": "6"}]
  }],
  "usage": {
    "input_tokens": 30,
    "output_tokens": 5,
    "total_tokens": 35
  }
}

event: response.created
data: {"type":"response.created","response":{...}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"Hello"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":" world!"}

event: response.completed
data: {"type":"response.completed","response":{...usage...}}

curl https://api.yunjunet.cn/v1beta/models/claude-sonnet-4-6:generateContent \
  -H "Content-Type: application/json" \
  -H "x-goog-api-key: sk-your-api-key" \
  -d '{
    "contents": [
      {"role": "user", "parts": [{"text": "Hello!"}]}
    ],
    "generationConfig": {
      "maxOutputTokens": 1024,
      "temperature": 0.7
    }
  }'

{
  "candidates": [{
    "content": {
      "parts": [{"text": "Hello! How can I help you today?"}],
      "role": "model"
    },
    "finishReason": "STOP",
    "index": 0
  }],
  "usageMetadata": {
    "promptTokenCount": 10,
    "candidatesTokenCount": 12,
    "totalTokenCount": 22
  },
  "modelVersion": "claude-sonnet-4-6"
}

POST /v1beta/models/claude-sonnet-4-6:streamGenerateContent

# 响应格式（每个 chunk 为独立 JSON）
data: {"candidates":[{"content":{"parts":[{"text":"Hello"}],"role":"model"},"index":0}],"modelVersion":"claude-sonnet-4-6"}

data: {"candidates":[{"content":{"parts":[{"text":"!"}],"role":"model"},"index":0}],"modelVersion":"claude-sonnet-4-6"}

data: {"candidates":[{"content":{"parts":[{"text":""}],"role":"model"},"finishReason":"STOP","index":0}],"usageMetadata":{"promptTokenCount":10,"candidatesTokenCount":12,"totalTokenCount":22}}

# ~/.codex/config.toml
model = "claude-sonnet-4-6"
model_provider = "openclaw"

[model_providers.openclaw]
name = "OpenClaw API"
base_url = "https://api.yunjunet.cn/v1"
wire_api = "responses"
env_key = "OPENCLAW_API_KEY"

# 设置 API Key
export OPENCLAW_API_KEY=sk-your-api-key

# 启动 Codex
codex

# Bash
echo 'export OPENCLAW_API_KEY=sk-your-api-key' >> ~/.bashrc && source ~/.bashrc

# Zsh
echo 'export OPENCLAW_API_KEY=sk-your-api-key' >> ~/.zshrc && source ~/.zshrc

# 设置环境变量
export GEMINI_API_KEY=sk-your-api-key
export GEMINI_BASE_URL=https://api.yunjunet.cn/v1beta/

# 启动 Gemini CLI
gemini

# Bash 用户
echo 'export GEMINI_API_KEY=sk-your-api-key' >> ~/.bashrc
echo 'export GEMINI_BASE_URL=https://api.yunjunet.cn/v1beta/' >> ~/.bashrc
source ~/.bashrc

# Zsh 用户
echo 'export GEMINI_API_KEY=sk-your-api-key' >> ~/.zshrc
echo 'export GEMINI_BASE_URL=https://api.yunjunet.cn/v1beta/' >> ~/.zshrc
source ~/.zshrc

openclaw onboard

openclaw onboard \
  --auth-choice custom-api-key \
  --custom-provider-id my-local-model \
  --custom-base-url http://localhost:8000/v1 \
  --custom-model-id deepseek-coder-v2 \
  --custom-api-key "your-api-key-if-needed" \
  --custom-compatibility openai

{
  "models": {
    "providers": {
      "my-provider": {
        "baseUrl": "https://api.example.com/v1",
        "apiKey": "${MY_PROVIDER_API_KEY}",
        "api": "openai-completions",
        "models": [
          {
            "id": "model-a",
            "name": "Model A"
          }
        ]
      }
    }
  }
}

{
  "models": {
    "providers": {
      "lmstudio": {
        "baseUrl": "http://localhost:1234/v1",
        "apiKey": "lmstudio-key",
        "api": "openai-completions",
        "models": [
          {
            "id": "minimax-m2.5-gs32",
            "name": "MiniMax M2.5 (Local)",
            "contextWindow": 200000,
            "maxTokens": 8192,
            "reasoning": false,
            "input": ["text"],
            "cost": {
              "input": 0,
              "output": 0,
              "cacheRead": 0,
              "cacheWrite": 0
            }
          }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "lmstudio/minimax-m2.5-gs32"
      }
    }
  }
}

openclaw models list
openclaw models set lmstudio/minimax-m2.5-gs32

# 在终端中设置环境变量（注意：不要加 /v1，CLI 会自动拼接）
export ANTHROPIC_BASE_URL=https://api.yunjunet.cn
export ANTHROPIC_AUTH_TOKEN=sk-your-api-key

# 启动 Claude Code（可指定任意已启用的模型）
claude
claude --model deepseek-chat
claude --model claude-haiku-4-5

# Bash 用户
echo 'export ANTHROPIC_BASE_URL=https://api.yunjunet.cn' >> ~/.bashrc
echo 'export ANTHROPIC_AUTH_TOKEN=sk-your-api-key' >> ~/.bashrc
source ~/.bashrc

# Zsh 用户
echo 'export ANTHROPIC_BASE_URL=https://api.yunjunet.cn' >> ~/.zshrc
echo 'export ANTHROPIC_AUTH_TOKEN=sk-your-api-key' >> ~/.zshrc
source ~/.zshrc

pip install anthropic

import anthropic

client = anthropic.Anthropic(
    base_url="https://api.yunjunet.cn",
    api_key="sk-your-api-key"
)

message = client.messages.create(
    model="claude-haiku-4-5",
    max_tokens=1024,
    messages=[{"role": "user", "content": "Hello!"}]
)
print(message.content[0].text)

data: {"id":"chatcmpl-xxx","choices":[{"delta":{"content":"你"},"index":0}]}

data: {"id":"chatcmpl-xxx","choices":[{"delta":{"content":"好"},"index":0}]}

data: {"id":"chatcmpl-xxx","choices":[{"delta":{},"index":0,"finish_reason":"stop"}]}

data: [DONE]

stream = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "写一首诗"}],
    stream=True
)
for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

服务商名称: OpenClaw API
API 地址:   https://api.yunjunet.cn/v1
API Key:    sk-your-api-key

接口地址: https://api.yunjunet.cn
API Key:  sk-your-api-key
自定义模型: claude-sonnet-4-6,deepseek-chat,gpt-4o

OPENAI_API_KEY=sk-your-api-key
BASE_URL=https://api.yunjunet.cn
CUSTOM_MODELS=claude-sonnet-4-6,deepseek-chat,gpt-4o,gpt-4o-mini

API Key:    sk-your-api-key
代理地址:   https://api.yunjunet.cn/v1

OPENAI_API_KEY=sk-your-api-key
OPENAI_PROXY_URL=https://api.yunjunet.cn/v1
OPENAI_MODEL_LIST=claude-sonnet-4-6,claude-haiku-4-5,deepseek-chat,gpt-4o

设置 → AI 服务商 → Anthropic
API Key:  sk-your-api-key
API 地址: https://api.yunjunet.cn

OpenAI API 域名: https://api.yunjunet.cn
API Key:         sk-your-api-key
模型:            claude-sonnet-4-6（或任意平台模型 ID）

OpenAI API Key:       sk-your-api-key
Override Base URL:    https://api.yunjunet.cn/v1

API Key:  sk-your-api-key
Base URL: https://api.yunjunet.cn/v1
Model:    claude-sonnet-4-6

API Provider:  OpenAI Compatible
Base URL:      https://api.yunjunet.cn/v1
API Key:       sk-your-api-key
Model ID:      claude-sonnet-4-6

API Provider:   Anthropic
Base URL:       https://api.yunjunet.cn
API Key:        sk-your-api-key
Model:          claude-sonnet-4-6

{
  "models": [
    {
      "title": "Claude Sonnet (OpenClaw)",
      "provider": "openai",
      "model": "claude-sonnet-4-6",
      "apiKey": "sk-your-api-key",
      "apiBase": "https://api.yunjunet.cn/v1"
    },
    {
      "title": "DeepSeek Chat (OpenClaw)",
      "provider": "openai",
      "model": "deepseek-chat",
      "apiKey": "sk-your-api-key",
      "apiBase": "https://api.yunjunet.cn/v1"
    }
  ],
  "tabAutocompleteModel": {
    "title": "Autocomplete",
    "provider": "openai",
    "model": "deepseek-chat",
    "apiKey": "sk-your-api-key",
    "apiBase": "https://api.yunjunet.cn/v1"
  }
}

{
  "models": [
    {
      "title": "Claude Sonnet (Anthropic)",
      "provider": "anthropic",
      "model": "claude-sonnet-4-6",
      "apiKey": "sk-your-api-key",
      "apiBase": "https://api.yunjunet.cn"
    }
  ]
}

# VS Code：Ctrl/Cmd+Shift+P，输入：Continue: Open config.json
# 或直接编辑
~/.continue/config.json