TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:00:28

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

    Use this file to discover all available pages before exploring further.

    Models

    text
    openclaw models

    Model discovery, scanning, and configuration (default model, fallbacks, auth profiles).

    Related:

    • Providers + models: Models
    • Model selection concepts +
      text
      /models
      slash command: Models concept
    • Provider auth setup: Getting started

    Common commands

    bash
    openclaw models status openclaw models list openclaw models set <model-or-alias> openclaw models scan

    text
    openclaw models status
    shows the resolved default/fallbacks plus an auth overview. When provider usage snapshots are available, the OAuth/API-key status section includes provider usage windows and quota snapshots. Current usage-window providers: Anthropic, GitHub Copilot, Gemini CLI, OpenAI Codex, MiniMax, Xiaomi, and z.ai. Usage auth comes from provider-specific hooks when available; otherwise OpenClaw falls back to matching OAuth/API-key credentials from auth profiles, env, or config. In
    text
    --json
    output,
    text
    auth.providers
    is the env/config/store-aware provider overview, while
    text
    auth.oauth
    is auth-store profile health only. Add
    text
    --probe
    to run live auth probes against each configured provider profile. Probes are real requests (may consume tokens and trigger rate limits). Use
    text
    --agent <id>
    to inspect a configured agent’s model/auth state. When omitted, the command uses
    text
    OPENCLAW_AGENT_DIR
    /
    text
    PI_CODING_AGENT_DIR
    if set, otherwise the configured default agent. Probe rows can come from auth profiles, env credentials, or
    text
    models.json
    .

    Notes:

    • text
      models set <model-or-alias>
      accepts
      text
      provider/model
      or an alias.
    • text
      models list
      is read-only: it reads config, auth profiles, existing catalog state, and provider-owned catalog rows, but it does not rewrite
      text
      models.json
      .
    • The
      text
      Auth
      column is provider-level and read-only. It is computed from local auth profile metadata, env markers, configured provider keys, local-provider markers, AWS Bedrock env/profile markers, and plugin synthetic-auth metadata; it does not load provider runtime, read keychain secrets, call provider APIs, or prove exact per-model execution readiness.
    • text
      models list --all --provider <id>
      can include provider-owned static catalog rows from plugin manifests or bundled provider catalog metadata even when you have not authenticated with that provider yet. Those rows still show as unavailable until matching auth is configured.
    • text
      models list
      keeps the control plane responsive while provider catalog discovery is slow. The default and configured views fall back to configured or synthetic model rows after a short wait and let discovery finish in the background. Use
      text
      --all
      when you need the exact full discovered catalog and are willing to wait for provider discovery.
    • Broad
      text
      models list --all
      merges manifest catalog rows over registry rows without loading provider runtime supplement hooks. Provider-filtered manifest fast paths use only providers marked
      text
      static
      ; providers marked
      text
      refreshable
      stay registry/cache-backed and append manifest rows as supplements, while providers marked
      text
      runtime
      stay on registry/runtime discovery.
    • text
      models list
      keeps native model metadata and runtime caps distinct. In table output,
      text
      Ctx
      shows
      text
      contextTokens/contextWindow
      when an effective runtime cap differs from the native context window; JSON rows include
      text
      contextTokens
      when a provider exposes that cap.
    • text
      models list --provider <id>
      filters by provider id, such as
      text
      moonshot
      or
      text
      openai-codex
      . It does not accept display labels from interactive provider pickers, such as
      text
      Moonshot AI
      .
    • Model refs are parsed by splitting on the first
      text
      /
      . If the model ID includes
      text
      /
      (OpenRouter-style), include the provider prefix (example:
      text
      openrouter/moonshotai/kimi-k2
      ).
    • If you omit the provider, OpenClaw resolves the input as an alias first, then as a unique configured-provider match for that exact model id, and only then falls back to the configured default provider with a deprecation warning. If that provider no longer exposes the configured default model, OpenClaw falls back to the first configured provider/model instead of surfacing a stale removed-provider default.
    • text
      models status
      may show
      text
      marker(<value>)
      in auth output for non-secret placeholders (for example
      text
      OPENAI_API_KEY
      ,
      text
      secretref-managed
      ,
      text
      minimax-oauth
      ,
      text
      oauth:chutes
      ,
      text
      ollama-local
      ) instead of masking them as secrets.

    Models scan

    text
    models scan
    reads OpenRouter's public
    text
    :free
    catalog and ranks candidates for fallback use. The catalog itself is public, so metadata-only scans do not need an OpenRouter key.

    By default OpenClaw tries to probe tool and image support with live model calls. If no OpenRouter key is configured, the command falls back to metadata-only output and explains that

    text
    :free
    models still require
    text
    OPENROUTER_API_KEY
    for probes and inference.

    Options:

    • text
      --no-probe
      (metadata only; no config/secrets lookup)
    • text
      --min-params <b>
    • text
      --max-age-days <days>
    • text
      --provider <name>
    • text
      --max-candidates <n>
    • text
      --timeout <ms>
      (catalog request and per-probe timeout)
    • text
      --concurrency <n>
    • text
      --yes
    • text
      --no-input
    • text
      --set-default
    • text
      --set-image
    • text
      --json

    text
    --set-default
    and
    text
    --set-image
    require live probes; metadata-only scan results are informational and are not applied to config.

    Models status

    Options:

    • text
      --json
    • text
      --plain
    • text
      --check
      (exit 1=expired/missing, 2=expiring)
    • text
      --probe
      (live probe of configured auth profiles)
    • text
      --probe-provider <name>
      (probe one provider)
    • text
      --probe-profile <id>
      (repeat or comma-separated profile ids)
    • text
      --probe-timeout <ms>
    • text
      --probe-concurrency <n>
    • text
      --probe-max-tokens <n>
    • text
      --agent <id>
      (configured agent id; overrides
      text
      OPENCLAW_AGENT_DIR
      /
      text
      PI_CODING_AGENT_DIR
      )

    text
    --json
    keeps stdout reserved for the JSON payload. Auth-profile, provider, and startup diagnostics are routed to stderr so scripts can pipe stdout directly into tools such as
    text
    jq
    .

    Probe status buckets:

    • text
      ok
    • text
      auth
    • text
      rate_limit
    • text
      billing
    • text
      timeout
    • text
      format
    • text
      unknown
    • text
      no_model

    Probe detail/reason-code cases to expect:

    • text
      excluded_by_auth_order
      : a stored profile exists, but explicit
      text
      auth.order.<provider>
      omitted it, so probe reports the exclusion instead of trying it.
    • text
      missing_credential
      ,
      text
      invalid_expires
      ,
      text
      expired
      ,
      text
      unresolved_ref
      : profile is present but not eligible/resolvable.
    • text
      no_model
      : provider auth exists, but OpenClaw could not resolve a probeable model candidate for that provider.

    Aliases + fallbacks

    bash
    openclaw models aliases list openclaw models fallbacks list

    Auth profiles

    bash
    openclaw models auth add openclaw models auth login --provider <id> openclaw models auth setup-token --provider <id> openclaw models auth paste-token

    text
    models auth add
    is the interactive auth helper. It can launch a provider auth flow (OAuth/API key) or guide you into manual token paste, depending on the provider you choose.

    text
    models auth login
    runs a provider plugin’s auth flow (OAuth/API key). Use
    text
    openclaw plugins list
    to see which providers are installed. Use
    text
    openclaw models auth --agent <id> <subcommand>
    to write auth results to a specific configured agent store. The parent
    text
    --agent
    flag is honored by
    text
    add
    ,
    text
    login
    ,
    text
    setup-token
    ,
    text
    paste-token
    , and
    text
    login-github-copilot
    .

    Examples:

    bash
    openclaw models auth login --provider openai-codex --set-default

    Notes:

    • text
      setup-token
      and
      text
      paste-token
      remain generic token commands for providers that expose token auth methods.
    • text
      setup-token
      requires an interactive TTY and runs the provider's token-auth method (defaulting to that provider's
      text
      setup-token
      method when it exposes one).
    • text
      paste-token
      accepts a token string generated elsewhere or from automation.
    • text
      paste-token
      requires
      text
      --provider
      , prompts for the token value, and writes it to the default profile id
      text
      <provider>:manual
      unless you pass
      text
      --profile-id
      .
    • text
      paste-token --expires-in <duration>
      stores an absolute token expiry from a relative duration such as
      text
      365d
      or
      text
      12h
      .
    • Anthropic note: Anthropic staff told us OpenClaw-style Claude CLI usage is allowed again, so OpenClaw treats Claude CLI reuse and
      text
      claude -p
      usage as sanctioned for this integration unless Anthropic publishes a new policy.
    • Anthropic
      text
      setup-token
      /
      text
      paste-token
      remain available as a supported OpenClaw token path, but OpenClaw now prefers Claude CLI reuse and
      text
      claude -p
      when available.

    Related

    • CLI reference
    • Model selection
    • Model failover

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine