OpenClaw / Agent Plan reference

OpenClaw integration reference

Route OpenClaw's model provider and primary agent model through the Agent Plan endpoint with the official openai-responses adapter.

All tool integrationsOpenClaw

1 · Quick start

Connect OpenClaw in three moves

Start with the matching configuration file, keep the key in the named secret location, and use one exact Model ID throughout the setup.

Open the OpenClaw configuration

Edit ~/.openclaw/openclaw.json (or open it via openclaw dashboard → Settings → Advanced) and keep a backup of the existing provider and agent sections before merging changes.

Register the provider with its API adapter

Add the /v3 base URL, the delivered key, and "api": "openai-responses" under models.providers. Volcengine recommends the Responses API adapter; use "openai-completions" only if you specifically need Chat Completions.

Set the primary route

Point agents.defaults.model.primary to the same provider/model pair so OpenClaw does not register one model and call another.

The key is delivered to your Dashboard after payment. Replace the placeholder in the example, then keep the real value in your environment or local secret file.

2 · Configuration

Copy the provider blueprint

This is a safe starting point for the current Agent Plan route. Keep existing tool settings that are unrelated to the provider and replace only the placeholder key and Model ID values.

{
  "models": {
    "providers": {
      "volcengine-agent-plan": {
        "baseUrl": "https://ark.cn-beijing.volces.com/api/plan/v3",
        "apiKey": "YOUR_AGENT_PLAN_KEY",
        "api": "openai-responses",
        "models": [
          {
            "id": "glm-5.2",
            "name": "glm-5.2",
            "contextWindow": 1024000,
            "maxTokens": 65536
          }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": { "primary": "volcengine-agent-plan/glm-5.2" }
    }
  },
  "gateway": { "mode": "local" }
}

The default Model ID shown here is the stocked plan's current default. If you choose another supported model, replace every model field required by OpenClaw, not just the visible label.

Install / launch

curl -fsSL https://openclaw.ai/install.sh | bash

3 · Verify the route

Confirm the connection before a full project

Restart the OpenClaw process after changing openclaw.json.

Run openclaw tui and /status to confirm the gateway and the active provider route.

Inspect the active provider and primary route if a model-not-found error appears.

Troubleshooting

Common configuration pitfalls

Merge these objects with your existing config. Replacing the whole file can remove unrelated agents or channels.

Do not omit the api field: without the openai-responses (or openai-completions) adapter the provider will not speak the right protocol.

contextWindow and maxTokens mirror the official per-model caps; adjust both when switching models.

Official OpenClaw reference Compare other tools