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:03

    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.

    API usage and costs

    API usage & costs

    This doc lists features that can invoke API keys and where their costs show up. It focuses on OpenClaw features that can generate provider usage or paid API calls.

    Where costs show up (chat + CLI)

    Per-session cost snapshot

    • text
      /status
      shows the current session model, context usage, and last response tokens.
    • If the model uses API-key auth,
      text
      /status
      also shows estimated cost for the last reply.
    • If live session metadata is sparse,
      text
      /status
      can recover token/cache counters and the active runtime model label from the latest transcript usage entry. Existing nonzero live values still take precedence, and prompt-sized transcript totals can win when stored totals are missing or smaller.

    Per-message cost footer

    • text
      /usage full
      appends a usage footer to every reply, including estimated cost (API-key only).
    • text
      /usage tokens
      shows tokens only; subscription-style OAuth/token and CLI flows hide dollar cost.
    • Gemini CLI note: when the CLI returns JSON output, OpenClaw reads usage from
      text
      stats
      , normalizes
      text
      stats.cached
      into
      text
      cacheRead
      , and derives input tokens from
      text
      stats.input_tokens - stats.cached
      when needed.

    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 still does not expose a per-message dollar estimate that OpenClaw can show in
    text
    /usage full
    .

    CLI usage windows (provider quotas)

    • text
      openclaw status --usage
      and
      text
      openclaw channels list
      show provider usage windows (quota snapshots, not per-message costs).
    • Human output is normalized to
      text
      X% left
      across providers.
    • Current usage-window providers: Anthropic, GitHub Copilot, Gemini CLI, OpenAI Codex, MiniMax, Xiaomi, and z.ai.
    • MiniMax note: its raw
      text
      usage_percent
      /
      text
      usagePercent
      fields mean remaining quota, so OpenClaw inverts them before display. Count-based fields still win when present. If the provider returns
      text
      model_remains
      , OpenClaw prefers the chat-model entry, derives the window label from timestamps when needed, and includes the model name in the plan label.
    • Usage auth for those quota windows comes from provider-specific hooks when available; otherwise OpenClaw falls back to matching OAuth/API-key credentials from auth profiles, env, or config.

    See Token use & costs for details and examples.

    How keys are discovered

    OpenClaw can pick up credentials from:

    • Auth profiles (per-agent, stored in
      text
      auth-profiles.json
      ).
    • Environment variables (e.g.
      text
      OPENAI_API_KEY
      ,
      text
      BRAVE_API_KEY
      ,
      text
      FIRECRAWL_API_KEY
      ).
    • Config (
      text
      models.providers.*.apiKey
      ,
      text
      plugins.entries.*.config.webSearch.apiKey
      ,
      text
      plugins.entries.firecrawl.config.webFetch.apiKey
      ,
      text
      memorySearch.*
      ,
      text
      talk.providers.*.apiKey
      ).
    • Skills (
      text
      skills.entries.<name>.apiKey
      ) which may export keys to the skill process env.

    Features that can spend keys

    1) Core model responses (chat + tools)

    Every reply or tool call uses the current model provider (OpenAI, Anthropic, etc). This is the primary source of usage and cost.

    This also includes subscription-style hosted providers that still bill outside OpenClaw's local UI, such as OpenAI Codex, Alibaba Cloud Model Studio Coding Plan, MiniMax Coding Plan, Z.AI / GLM Coding Plan, and Anthropic's OpenClaw Claude-login path with Extra Usage enabled.

    See Models for pricing config and Token use & costs for display.

    2) Media understanding (audio/image/video)

    Inbound media can be summarized/transcribed before the reply runs. This uses model/provider APIs.

    • Audio: OpenAI / Groq / Deepgram / DeepInfra / Google / Mistral.
    • Image: OpenAI / OpenRouter / Anthropic / DeepInfra / Google / MiniMax / Moonshot / Qwen / Z.AI.
    • Video: Google / Qwen / Moonshot.

    See Media understanding.

    3) Image and video generation

    Shared generation capabilities can also spend provider keys:

    • Image generation: OpenAI / Google / DeepInfra / fal / MiniMax
    • Video generation: DeepInfra / Qwen

    Image generation can infer an auth-backed provider default when

    text
    agents.defaults.imageGenerationModel
    is unset. Video generation currently requires an explicit
    text
    agents.defaults.videoGenerationModel
    such as
    text
    qwen/wan2.6-t2v
    .

    See Image generation, Qwen Cloud, and Models.

    4) Memory embeddings + semantic search

    Semantic memory search uses embedding APIs when configured for remote providers:

    • text
      memorySearch.provider = "openai"
      → OpenAI embeddings
    • text
      memorySearch.provider = "gemini"
      → Gemini embeddings
    • text
      memorySearch.provider = "voyage"
      → Voyage embeddings
    • text
      memorySearch.provider = "mistral"
      → Mistral embeddings
    • text
      memorySearch.provider = "deepinfra"
      → DeepInfra embeddings
    • text
      memorySearch.provider = "lmstudio"
      → LM Studio embeddings (local/self-hosted)
    • text
      memorySearch.provider = "ollama"
      → Ollama embeddings (local/self-hosted; typically no hosted API billing)
    • Optional fallback to a remote provider if local embeddings fail

    You can keep it local with

    text
    memorySearch.provider = "local"
    (no API usage).

    See Memory.

    5) Web search tool

    text
    web_search
    may incur usage charges depending on your provider:

    • Brave Search API:
      text
      BRAVE_API_KEY
      or
      text
      plugins.entries.brave.config.webSearch.apiKey
    • Exa:
      text
      EXA_API_KEY
      or
      text
      plugins.entries.exa.config.webSearch.apiKey
    • Firecrawl:
      text
      FIRECRAWL_API_KEY
      or
      text
      plugins.entries.firecrawl.config.webSearch.apiKey
    • Gemini (Google Search):
      text
      GEMINI_API_KEY
      or
      text
      plugins.entries.google.config.webSearch.apiKey
    • Grok (xAI):
      text
      XAI_API_KEY
      or
      text
      plugins.entries.xai.config.webSearch.apiKey
    • Kimi (Moonshot):
      text
      KIMI_API_KEY
      ,
      text
      MOONSHOT_API_KEY
      , or
      text
      plugins.entries.moonshot.config.webSearch.apiKey
    • MiniMax Search:
      text
      MINIMAX_CODE_PLAN_KEY
      ,
      text
      MINIMAX_CODING_API_KEY
      ,
      text
      MINIMAX_API_KEY
      , or
      text
      plugins.entries.minimax.config.webSearch.apiKey
    • Ollama Web Search: key-free for a reachable signed-in local Ollama host; direct
      text
      https://ollama.com
      search uses
      text
      OLLAMA_API_KEY
      , and auth-protected hosts can reuse normal Ollama provider bearer auth
    • Perplexity Search API:
      text
      PERPLEXITY_API_KEY
      ,
      text
      OPENROUTER_API_KEY
      , or
      text
      plugins.entries.perplexity.config.webSearch.apiKey
    • Tavily:
      text
      TAVILY_API_KEY
      or
      text
      plugins.entries.tavily.config.webSearch.apiKey
    • DuckDuckGo: key-free fallback (no API billing, but unofficial and HTML-based)
    • SearXNG:
      text
      SEARXNG_BASE_URL
      or
      text
      plugins.entries.searxng.config.webSearch.baseUrl
      (key-free/self-hosted; no hosted API billing)

    Legacy

    text
    tools.web.search.*
    provider paths still load through the temporary compatibility shim, but they are no longer the recommended config surface.

    Brave Search free credit: Each Brave plan includes $5/month in renewing free credit. The Search plan costs $5 per 1,000 requests, so the credit covers 1,000 requests/month at no charge. Set your usage limit in the Brave dashboard to avoid unexpected charges.

    See Web tools.

    5) Web fetch tool (Firecrawl)

    text
    web_fetch
    can call Firecrawl when an API key is present:

    • text
      FIRECRAWL_API_KEY
      or
      text
      plugins.entries.firecrawl.config.webFetch.apiKey

    If Firecrawl isn’t configured, the tool falls back to direct fetch plus the bundled

    text
    web-readability
    plugin (no paid API). Disable
    text
    plugins.entries.web-readability.enabled
    to skip local Readability extraction.

    See Web tools.

    6) Provider usage snapshots (status/health)

    Some status commands call provider usage endpoints to display quota windows or auth health. These are typically low-volume calls but still hit provider APIs:

    • text
      openclaw status --usage
    • text
      openclaw models status --json

    See Models CLI.

    7) Compaction safeguard summarization

    The compaction safeguard can summarize session history using the current model, which invokes provider APIs when it runs.

    See Session management + compaction.

    8) Model scan / probe

    text
    openclaw models scan
    can probe OpenRouter models and uses
    text
    OPENROUTER_API_KEY
    when probing is enabled.

    See Models CLI.

    9) Talk (speech)

    Talk mode can invoke ElevenLabs when configured:

    • text
      ELEVENLABS_API_KEY
      or
      text
      talk.providers.elevenlabs.apiKey

    See Talk mode.

    10) Skills (third-party APIs)

    Skills can store

    text
    apiKey
    in
    text
    skills.entries.<name>.apiKey
    . If a skill uses that key for external APIs, it can incur costs according to the skill’s provider.

    See Skills.

    Related

    • Token use and costs
    • Prompt caching
    • Usage tracking

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine