nodmix 2026.5.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11573 -0
- package/LICENSE +21 -0
- package/README.md +486 -0
- package/docs/.i18n/README.md +81 -0
- package/docs/.i18n/ar-navigation.json +18 -0
- package/docs/.i18n/de-navigation.json +18 -0
- package/docs/.i18n/es-navigation.json +18 -0
- package/docs/.i18n/fr-navigation.json +18 -0
- package/docs/.i18n/glossary.ar.json +78 -0
- package/docs/.i18n/glossary.de.json +78 -0
- package/docs/.i18n/glossary.es.json +78 -0
- package/docs/.i18n/glossary.fa.json +78 -0
- package/docs/.i18n/glossary.fr.json +78 -0
- package/docs/.i18n/glossary.id.json +78 -0
- package/docs/.i18n/glossary.it.json +78 -0
- package/docs/.i18n/glossary.ja-JP.json +98 -0
- package/docs/.i18n/glossary.ko.json +78 -0
- package/docs/.i18n/glossary.nl.json +78 -0
- package/docs/.i18n/glossary.pl.json +78 -0
- package/docs/.i18n/glossary.pt-BR.json +78 -0
- package/docs/.i18n/glossary.th.json +78 -0
- package/docs/.i18n/glossary.tr.json +78 -0
- package/docs/.i18n/glossary.uk.json +78 -0
- package/docs/.i18n/glossary.vi.json +78 -0
- package/docs/.i18n/glossary.zh-CN.json +1002 -0
- package/docs/.i18n/glossary.zh-TW.json +78 -0
- package/docs/.i18n/id-navigation.json +18 -0
- package/docs/.i18n/it-navigation.json +18 -0
- package/docs/.i18n/ja-navigation.json +18 -0
- package/docs/.i18n/ko-navigation.json +18 -0
- package/docs/.i18n/pl-navigation.json +18 -0
- package/docs/.i18n/pt-BR-navigation.json +18 -0
- package/docs/.i18n/tr-navigation.json +18 -0
- package/docs/.i18n/translation-workflow.md +111 -0
- package/docs/.i18n/zh-Hans-navigation.json +542 -0
- package/docs/AGENTS.md +36 -0
- package/docs/announcements/bluebubbles-imessage.md +79 -0
- package/docs/assets/install-script.svg +1 -0
- package/docs/assets/macos-onboarding/01-macos-warning.jpeg +0 -0
- package/docs/assets/macos-onboarding/02-local-networks.jpeg +0 -0
- package/docs/assets/macos-onboarding/03-security-notice.png +0 -0
- package/docs/assets/macos-onboarding/04-choose-gateway.png +0 -0
- package/docs/assets/macos-onboarding/05-permissions.png +0 -0
- package/docs/assets/openclaw-logo-text-dark.png +0 -0
- package/docs/assets/openclaw-logo-text-dark.svg +418 -0
- package/docs/assets/openclaw-logo-text.png +0 -0
- package/docs/assets/openclaw-logo-text.svg +418 -0
- package/docs/assets/pixel-lobster.svg +60 -0
- package/docs/assets/pr/quick-settings-browser-tools.png +0 -0
- package/docs/assets/showcase/agents-ui.jpg +0 -0
- package/docs/assets/showcase/bambu-cli.png +0 -0
- package/docs/assets/showcase/codexmonitor.png +0 -0
- package/docs/assets/showcase/gohome-grafana.png +0 -0
- package/docs/assets/showcase/ios-testflight.jpg +0 -0
- package/docs/assets/showcase/oura-health.png +0 -0
- package/docs/assets/showcase/padel-cli.svg +11 -0
- package/docs/assets/showcase/padel-screenshot.jpg +0 -0
- package/docs/assets/showcase/papla-tts.jpg +0 -0
- package/docs/assets/showcase/pr-review-telegram.jpg +0 -0
- package/docs/assets/showcase/roborock-screenshot.jpg +0 -0
- package/docs/assets/showcase/roborock-status.svg +13 -0
- package/docs/assets/showcase/roof-camera-sky.jpg +0 -0
- package/docs/assets/showcase/snag.png +0 -0
- package/docs/assets/showcase/tesco-shop.jpg +0 -0
- package/docs/assets/showcase/wienerlinien.png +0 -0
- package/docs/assets/showcase/wine-cellar-skill.jpg +0 -0
- package/docs/assets/showcase/winix-air-purifier.jpg +0 -0
- package/docs/assets/showcase/xuezh-pronunciation.jpeg +0 -0
- package/docs/assets/sponsors/blacksmith-light.svg +14 -0
- package/docs/assets/sponsors/blacksmith.svg +14 -0
- package/docs/assets/sponsors/convex-light.svg +16 -0
- package/docs/assets/sponsors/convex.svg +16 -0
- package/docs/assets/sponsors/github-light.svg +3 -0
- package/docs/assets/sponsors/github.svg +3 -0
- package/docs/assets/sponsors/nvidia-dark.svg +9 -0
- package/docs/assets/sponsors/nvidia.svg +9 -0
- package/docs/assets/sponsors/openai-light.svg +3 -0
- package/docs/assets/sponsors/openai.svg +3 -0
- package/docs/assets/sponsors/vercel-light.svg +5 -0
- package/docs/assets/sponsors/vercel.svg +5 -0
- package/docs/auth-credential-semantics.md +124 -0
- package/docs/automation/auth-monitoring.md +11 -0
- package/docs/automation/clawflow.md +12 -0
- package/docs/automation/cron-jobs.md +500 -0
- package/docs/automation/cron-vs-heartbeat.md +11 -0
- package/docs/automation/gmail-pubsub.md +11 -0
- package/docs/automation/hooks.md +365 -0
- package/docs/automation/index.md +135 -0
- package/docs/automation/poll.md +12 -0
- package/docs/automation/standing-orders.md +250 -0
- package/docs/automation/taskflow.md +155 -0
- package/docs/automation/tasks.md +374 -0
- package/docs/automation/troubleshooting.md +12 -0
- package/docs/automation/webhook.md +12 -0
- package/docs/brave-search.md +11 -0
- package/docs/channels/access-groups.md +201 -0
- package/docs/channels/ambient-room-events.md +214 -0
- package/docs/channels/bot-loop-protection.md +131 -0
- package/docs/channels/broadcast-groups.md +472 -0
- package/docs/channels/channel-routing.md +162 -0
- package/docs/channels/clickclack.md +138 -0
- package/docs/channels/discord.md +1762 -0
- package/docs/channels/feishu.md +502 -0
- package/docs/channels/googlechat.md +284 -0
- package/docs/channels/group-messages.md +95 -0
- package/docs/channels/groups.md +519 -0
- package/docs/channels/imessage-from-bluebubbles.md +259 -0
- package/docs/channels/imessage.md +813 -0
- package/docs/channels/index.md +64 -0
- package/docs/channels/irc.md +253 -0
- package/docs/channels/line.md +243 -0
- package/docs/channels/location.md +71 -0
- package/docs/channels/matrix-migration.md +370 -0
- package/docs/channels/matrix-presentation.md +77 -0
- package/docs/channels/matrix-push-rules.md +150 -0
- package/docs/channels/matrix.md +921 -0
- package/docs/channels/mattermost.md +542 -0
- package/docs/channels/msteams.md +1042 -0
- package/docs/channels/nextcloud-talk.md +176 -0
- package/docs/channels/nostr.md +253 -0
- package/docs/channels/pairing.md +214 -0
- package/docs/channels/qqbot.md +309 -0
- package/docs/channels/signal.md +400 -0
- package/docs/channels/slack.md +1564 -0
- package/docs/channels/synology-chat.md +187 -0
- package/docs/channels/telegram.md +1107 -0
- package/docs/channels/tlon.md +296 -0
- package/docs/channels/troubleshooting.md +161 -0
- package/docs/channels/twitch.md +431 -0
- package/docs/channels/wechat.md +171 -0
- package/docs/channels/whatsapp.md +739 -0
- package/docs/channels/yuanbao.md +416 -0
- package/docs/channels/zalo.md +253 -0
- package/docs/channels/zalouser.md +199 -0
- package/docs/ci.md +612 -0
- package/docs/clawhub/publishing.md +96 -0
- package/docs/cli/acp.md +370 -0
- package/docs/cli/agent.md +103 -0
- package/docs/cli/agents.md +232 -0
- package/docs/cli/approvals.md +190 -0
- package/docs/cli/backup.md +97 -0
- package/docs/cli/browser.md +307 -0
- package/docs/cli/channels.md +154 -0
- package/docs/cli/clawbot.md +25 -0
- package/docs/cli/commitments.md +90 -0
- package/docs/cli/completion.md +39 -0
- package/docs/cli/config.md +504 -0
- package/docs/cli/configure.md +77 -0
- package/docs/cli/crestodian.md +332 -0
- package/docs/cli/cron.md +281 -0
- package/docs/cli/daemon.md +67 -0
- package/docs/cli/dashboard.md +33 -0
- package/docs/cli/devices.md +204 -0
- package/docs/cli/directory.md +68 -0
- package/docs/cli/dns.md +53 -0
- package/docs/cli/docs.md +73 -0
- package/docs/cli/doctor.md +237 -0
- package/docs/cli/flows.md +52 -0
- package/docs/cli/gateway.md +567 -0
- package/docs/cli/health.md +43 -0
- package/docs/cli/hooks.md +345 -0
- package/docs/cli/index.md +396 -0
- package/docs/cli/infer.md +364 -0
- package/docs/cli/logs.md +65 -0
- package/docs/cli/mcp.md +529 -0
- package/docs/cli/memory.md +183 -0
- package/docs/cli/message.md +317 -0
- package/docs/cli/migrate.md +290 -0
- package/docs/cli/models.md +224 -0
- package/docs/cli/node.md +177 -0
- package/docs/cli/nodes.md +76 -0
- package/docs/cli/onboard.md +245 -0
- package/docs/cli/pairing.md +77 -0
- package/docs/cli/path.md +502 -0
- package/docs/cli/plugins.md +454 -0
- package/docs/cli/policy.md +418 -0
- package/docs/cli/proxy.md +89 -0
- package/docs/cli/qr.md +56 -0
- package/docs/cli/reset.md +39 -0
- package/docs/cli/sandbox.md +208 -0
- package/docs/cli/secrets.md +202 -0
- package/docs/cli/security.md +124 -0
- package/docs/cli/sessions.md +164 -0
- package/docs/cli/setup.md +59 -0
- package/docs/cli/skills.md +102 -0
- package/docs/cli/status.md +45 -0
- package/docs/cli/system.md +89 -0
- package/docs/cli/tasks.md +111 -0
- package/docs/cli/tui.md +89 -0
- package/docs/cli/uninstall.md +44 -0
- package/docs/cli/update.md +242 -0
- package/docs/cli/voicecall.md +204 -0
- package/docs/cli/webhooks.md +117 -0
- package/docs/cli/wiki.md +256 -0
- package/docs/concepts/active-memory.md +856 -0
- package/docs/concepts/agent-loop.md +185 -0
- package/docs/concepts/agent-runtimes.md +243 -0
- package/docs/concepts/agent-workspace.md +230 -0
- package/docs/concepts/agent.md +136 -0
- package/docs/concepts/architecture.md +154 -0
- package/docs/concepts/channel-docking.md +145 -0
- package/docs/concepts/commitments.md +150 -0
- package/docs/concepts/compaction.md +203 -0
- package/docs/concepts/context-engine.md +306 -0
- package/docs/concepts/context.md +199 -0
- package/docs/concepts/delegate-architecture.md +319 -0
- package/docs/concepts/dreaming.md +261 -0
- package/docs/concepts/experimental-features.md +108 -0
- package/docs/concepts/features.md +91 -0
- package/docs/concepts/mantis-slack-desktop-runbook.md +202 -0
- package/docs/concepts/mantis.md +740 -0
- package/docs/concepts/markdown-formatting.md +139 -0
- package/docs/concepts/memory-builtin.md +146 -0
- package/docs/concepts/memory-honcho.md +144 -0
- package/docs/concepts/memory-qmd.md +271 -0
- package/docs/concepts/memory-search.md +166 -0
- package/docs/concepts/memory.md +258 -0
- package/docs/concepts/message-lifecycle-refactor.md +1128 -0
- package/docs/concepts/messages.md +214 -0
- package/docs/concepts/model-failover.md +385 -0
- package/docs/concepts/model-providers.md +715 -0
- package/docs/concepts/models.md +370 -0
- package/docs/concepts/multi-agent.md +619 -0
- package/docs/concepts/oauth.md +198 -0
- package/docs/concepts/openclaw-sdk.md +323 -0
- package/docs/concepts/parallel-specialist-lanes.md +127 -0
- package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
- package/docs/concepts/presence.md +117 -0
- package/docs/concepts/progress-drafts.md +362 -0
- package/docs/concepts/qa-e2e-automation.md +820 -0
- package/docs/concepts/qa-matrix.md +139 -0
- package/docs/concepts/queue-steering.md +90 -0
- package/docs/concepts/queue.md +122 -0
- package/docs/concepts/retry.md +86 -0
- package/docs/concepts/session-pruning.md +104 -0
- package/docs/concepts/session-tool.md +190 -0
- package/docs/concepts/session.md +164 -0
- package/docs/concepts/soul.md +116 -0
- package/docs/concepts/streaming.md +251 -0
- package/docs/concepts/system-prompt.md +310 -0
- package/docs/concepts/timezone.md +47 -0
- package/docs/concepts/typebox.md +309 -0
- package/docs/concepts/typing-indicators.md +88 -0
- package/docs/concepts/usage-tracking.md +66 -0
- package/docs/date-time.md +126 -0
- package/docs/debug/node-issue.md +90 -0
- package/docs/diagnostics/flags.md +138 -0
- package/docs/docs.json +1832 -0
- package/docs/gateway/authentication.md +239 -0
- package/docs/gateway/background-process.md +147 -0
- package/docs/gateway/bonjour.md +303 -0
- package/docs/gateway/bridge-protocol.md +94 -0
- package/docs/gateway/cli-backends.md +420 -0
- package/docs/gateway/config-agents.md +1514 -0
- package/docs/gateway/config-channels.md +945 -0
- package/docs/gateway/config-tools.md +769 -0
- package/docs/gateway/configuration-examples.md +705 -0
- package/docs/gateway/configuration-reference.md +1393 -0
- package/docs/gateway/configuration.md +737 -0
- package/docs/gateway/diagnostics.md +213 -0
- package/docs/gateway/discovery.md +154 -0
- package/docs/gateway/doctor.md +574 -0
- package/docs/gateway/gateway-lock.md +37 -0
- package/docs/gateway/health.md +73 -0
- package/docs/gateway/heartbeat.md +493 -0
- package/docs/gateway/index.md +383 -0
- package/docs/gateway/local-model-services.md +205 -0
- package/docs/gateway/local-models.md +355 -0
- package/docs/gateway/logging.md +149 -0
- package/docs/gateway/multiple-gateways.md +178 -0
- package/docs/gateway/network-model.md +15 -0
- package/docs/gateway/openai-http-api.md +350 -0
- package/docs/gateway/openresponses-http-api.md +347 -0
- package/docs/gateway/openshell.md +316 -0
- package/docs/gateway/opentelemetry.md +404 -0
- package/docs/gateway/operator-scopes.md +111 -0
- package/docs/gateway/pairing.md +207 -0
- package/docs/gateway/prometheus.md +230 -0
- package/docs/gateway/protocol.md +803 -0
- package/docs/gateway/remote-gateway-readme.md +169 -0
- package/docs/gateway/remote.md +280 -0
- package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +146 -0
- package/docs/gateway/sandboxing.md +545 -0
- package/docs/gateway/secrets-plan-contract.md +114 -0
- package/docs/gateway/secrets.md +609 -0
- package/docs/gateway/security/audit-checks.md +127 -0
- package/docs/gateway/security/index.md +1326 -0
- package/docs/gateway/security/secure-file-operations.md +76 -0
- package/docs/gateway/tailscale.md +156 -0
- package/docs/gateway/tools-invoke-http-api.md +169 -0
- package/docs/gateway/troubleshooting.md +772 -0
- package/docs/gateway/trusted-proxy-auth.md +451 -0
- package/docs/help/debugging.md +344 -0
- package/docs/help/environment.md +214 -0
- package/docs/help/faq-first-run.md +867 -0
- package/docs/help/faq-models.md +553 -0
- package/docs/help/faq.md +1975 -0
- package/docs/help/gpt55-codex-agentic-parity-maintainers.md +196 -0
- package/docs/help/gpt55-codex-agentic-parity.md +230 -0
- package/docs/help/index.md +39 -0
- package/docs/help/scripts.md +56 -0
- package/docs/help/testing-live.md +580 -0
- package/docs/help/testing-updates-plugins.md +291 -0
- package/docs/help/testing.md +928 -0
- package/docs/help/troubleshooting.md +424 -0
- package/docs/images/configure-model-picker-unsearchable.png +0 -0
- package/docs/images/feishu-get-group-id.png +0 -0
- package/docs/images/groups-flow.svg +52 -0
- package/docs/images/mobile-ui-screenshot.png +0 -0
- package/docs/index.md +196 -0
- package/docs/install/ansible.md +233 -0
- package/docs/install/azure.md +315 -0
- package/docs/install/bun.md +59 -0
- package/docs/install/clawdock.md +112 -0
- package/docs/install/development-channels.md +135 -0
- package/docs/install/digitalocean.md +174 -0
- package/docs/install/docker-vm-runtime.md +154 -0
- package/docs/install/docker.md +562 -0
- package/docs/install/exe-dev.md +201 -0
- package/docs/install/fly.md +524 -0
- package/docs/install/gcp.md +418 -0
- package/docs/install/hetzner.md +285 -0
- package/docs/install/hostinger.md +98 -0
- package/docs/install/index.md +221 -0
- package/docs/install/installer.md +455 -0
- package/docs/install/kubernetes.md +196 -0
- package/docs/install/macos-vm.md +281 -0
- package/docs/install/migrating-claude.md +165 -0
- package/docs/install/migrating-hermes.md +177 -0
- package/docs/install/migrating.md +137 -0
- package/docs/install/nix.md +112 -0
- package/docs/install/node.md +142 -0
- package/docs/install/northflank.mdx +44 -0
- package/docs/install/oracle.md +218 -0
- package/docs/install/podman.md +210 -0
- package/docs/install/railway.mdx +92 -0
- package/docs/install/raspberry-pi.md +234 -0
- package/docs/install/render.mdx +167 -0
- package/docs/install/uninstall.md +131 -0
- package/docs/install/updating.md +280 -0
- package/docs/logging.md +318 -0
- package/docs/nav-tabs-underline.js +100 -0
- package/docs/network.md +72 -0
- package/docs/nodes/audio.md +215 -0
- package/docs/nodes/camera.md +166 -0
- package/docs/nodes/images.md +77 -0
- package/docs/nodes/index.md +439 -0
- package/docs/nodes/location-command.md +102 -0
- package/docs/nodes/media-understanding.md +469 -0
- package/docs/nodes/talk.md +154 -0
- package/docs/nodes/troubleshooting.md +123 -0
- package/docs/nodes/voicewake.md +93 -0
- package/docs/perplexity.md +11 -0
- package/docs/pi-dev.md +82 -0
- package/docs/pi.md +573 -0
- package/docs/plan/codex-context-engine-harness.md +624 -0
- package/docs/plan/ui-channels.md +284 -0
- package/docs/platforms/android.md +285 -0
- package/docs/platforms/digitalocean.md +12 -0
- package/docs/platforms/index.md +60 -0
- package/docs/platforms/ios.md +283 -0
- package/docs/platforms/linux.md +141 -0
- package/docs/platforms/mac/bundled-gateway.md +79 -0
- package/docs/platforms/mac/canvas.md +128 -0
- package/docs/platforms/mac/child-process.md +72 -0
- package/docs/platforms/mac/dev-setup.md +112 -0
- package/docs/platforms/mac/health.md +39 -0
- package/docs/platforms/mac/icon.md +36 -0
- package/docs/platforms/mac/logging.md +62 -0
- package/docs/platforms/mac/menu-bar.md +93 -0
- package/docs/platforms/mac/peekaboo.md +92 -0
- package/docs/platforms/mac/permissions.md +53 -0
- package/docs/platforms/mac/remote.md +123 -0
- package/docs/platforms/mac/signing.md +52 -0
- package/docs/platforms/mac/skills.md +43 -0
- package/docs/platforms/mac/voice-overlay.md +66 -0
- package/docs/platforms/mac/voicewake.md +73 -0
- package/docs/platforms/mac/webchat.md +54 -0
- package/docs/platforms/mac/xpc.md +66 -0
- package/docs/platforms/macos.md +226 -0
- package/docs/platforms/oracle.md +12 -0
- package/docs/platforms/raspberry-pi.md +13 -0
- package/docs/platforms/windows.md +286 -0
- package/docs/plugins/adding-capabilities.md +133 -0
- package/docs/plugins/admin-http-rpc.md +216 -0
- package/docs/plugins/agent-tools.md +13 -0
- package/docs/plugins/architecture-internals.md +1195 -0
- package/docs/plugins/architecture.md +481 -0
- package/docs/plugins/building-extensions.md +13 -0
- package/docs/plugins/building-plugins.md +330 -0
- package/docs/plugins/bundles.md +310 -0
- package/docs/plugins/cli-backend-plugins.md +310 -0
- package/docs/plugins/codex-computer-use.md +293 -0
- package/docs/plugins/codex-harness-reference.md +409 -0
- package/docs/plugins/codex-harness-runtime.md +247 -0
- package/docs/plugins/codex-harness.md +746 -0
- package/docs/plugins/codex-native-plugins.md +276 -0
- package/docs/plugins/community.md +77 -0
- package/docs/plugins/compatibility.md +164 -0
- package/docs/plugins/dependency-resolution.md +143 -0
- package/docs/plugins/google-meet.md +1737 -0
- package/docs/plugins/hooks.md +459 -0
- package/docs/plugins/install-overrides.md +80 -0
- package/docs/plugins/manage-plugins.md +210 -0
- package/docs/plugins/manifest.md +1359 -0
- package/docs/plugins/memory-lancedb.md +385 -0
- package/docs/plugins/memory-wiki.md +529 -0
- package/docs/plugins/message-presentation.md +473 -0
- package/docs/plugins/oc-path.md +166 -0
- package/docs/plugins/plugin-inventory.md +182 -0
- package/docs/plugins/reference/acpx.md +23 -0
- package/docs/plugins/reference/admin-http-rpc.md +23 -0
- package/docs/plugins/reference/alibaba.md +23 -0
- package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
- package/docs/plugins/reference/amazon-bedrock.md +23 -0
- package/docs/plugins/reference/anthropic-vertex.md +19 -0
- package/docs/plugins/reference/anthropic.md +23 -0
- package/docs/plugins/reference/arcee.md +23 -0
- package/docs/plugins/reference/azure-speech.md +23 -0
- package/docs/plugins/reference/bonjour.md +19 -0
- package/docs/plugins/reference/brave.md +23 -0
- package/docs/plugins/reference/browser.md +23 -0
- package/docs/plugins/reference/byteplus.md +19 -0
- package/docs/plugins/reference/canvas.md +19 -0
- package/docs/plugins/reference/cerebras.md +23 -0
- package/docs/plugins/reference/chutes.md +23 -0
- package/docs/plugins/reference/clickclack.md +23 -0
- package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
- package/docs/plugins/reference/codex.md +23 -0
- package/docs/plugins/reference/comfy.md +23 -0
- package/docs/plugins/reference/copilot-proxy.md +19 -0
- package/docs/plugins/reference/deepgram.md +23 -0
- package/docs/plugins/reference/deepinfra.md +23 -0
- package/docs/plugins/reference/deepseek.md +23 -0
- package/docs/plugins/reference/diagnostics-otel.md +19 -0
- package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
- package/docs/plugins/reference/diffs.md +19 -0
- package/docs/plugins/reference/discord.md +23 -0
- package/docs/plugins/reference/document-extract.md +23 -0
- package/docs/plugins/reference/duckduckgo.md +23 -0
- package/docs/plugins/reference/elevenlabs.md +23 -0
- package/docs/plugins/reference/exa.md +23 -0
- package/docs/plugins/reference/fal.md +23 -0
- package/docs/plugins/reference/feishu.md +23 -0
- package/docs/plugins/reference/file-transfer.md +19 -0
- package/docs/plugins/reference/firecrawl.md +23 -0
- package/docs/plugins/reference/fireworks.md +23 -0
- package/docs/plugins/reference/github-copilot.md +23 -0
- package/docs/plugins/reference/google-meet.md +23 -0
- package/docs/plugins/reference/google.md +23 -0
- package/docs/plugins/reference/googlechat.md +23 -0
- package/docs/plugins/reference/gradium.md +23 -0
- package/docs/plugins/reference/groq.md +23 -0
- package/docs/plugins/reference/huggingface.md +23 -0
- package/docs/plugins/reference/imessage.md +23 -0
- package/docs/plugins/reference/inworld.md +23 -0
- package/docs/plugins/reference/irc.md +23 -0
- package/docs/plugins/reference/kilocode.md +23 -0
- package/docs/plugins/reference/kimi.md +23 -0
- package/docs/plugins/reference/line.md +23 -0
- package/docs/plugins/reference/litellm.md +23 -0
- package/docs/plugins/reference/llm-task.md +19 -0
- package/docs/plugins/reference/lmstudio.md +23 -0
- package/docs/plugins/reference/lobster.md +19 -0
- package/docs/plugins/reference/matrix.md +23 -0
- package/docs/plugins/reference/mattermost.md +23 -0
- package/docs/plugins/reference/memory-core.md +19 -0
- package/docs/plugins/reference/memory-lancedb.md +23 -0
- package/docs/plugins/reference/memory-wiki.md +23 -0
- package/docs/plugins/reference/microsoft-foundry.md +19 -0
- package/docs/plugins/reference/microsoft.md +19 -0
- package/docs/plugins/reference/migrate-claude.md +19 -0
- package/docs/plugins/reference/migrate-hermes.md +19 -0
- package/docs/plugins/reference/minimax.md +23 -0
- package/docs/plugins/reference/mistral.md +23 -0
- package/docs/plugins/reference/moonshot.md +23 -0
- package/docs/plugins/reference/msteams.md +23 -0
- package/docs/plugins/reference/nextcloud-talk.md +23 -0
- package/docs/plugins/reference/nostr.md +23 -0
- package/docs/plugins/reference/nvidia.md +23 -0
- package/docs/plugins/reference/oc-path.md +23 -0
- package/docs/plugins/reference/ollama.md +23 -0
- package/docs/plugins/reference/open-prose.md +19 -0
- package/docs/plugins/reference/openai.md +23 -0
- package/docs/plugins/reference/opencode-go.md +23 -0
- package/docs/plugins/reference/opencode.md +23 -0
- package/docs/plugins/reference/openrouter.md +23 -0
- package/docs/plugins/reference/openshell.md +19 -0
- package/docs/plugins/reference/perplexity.md +23 -0
- package/docs/plugins/reference/policy.md +23 -0
- package/docs/plugins/reference/qa-channel.md +23 -0
- package/docs/plugins/reference/qa-lab.md +19 -0
- package/docs/plugins/reference/qa-matrix.md +19 -0
- package/docs/plugins/reference/qianfan.md +23 -0
- package/docs/plugins/reference/qqbot.md +23 -0
- package/docs/plugins/reference/qwen.md +23 -0
- package/docs/plugins/reference/runway.md +23 -0
- package/docs/plugins/reference/searxng.md +19 -0
- package/docs/plugins/reference/senseaudio.md +23 -0
- package/docs/plugins/reference/sglang.md +23 -0
- package/docs/plugins/reference/signal.md +23 -0
- package/docs/plugins/reference/skill-workshop.md +23 -0
- package/docs/plugins/reference/slack.md +23 -0
- package/docs/plugins/reference/stepfun.md +23 -0
- package/docs/plugins/reference/synology-chat.md +23 -0
- package/docs/plugins/reference/synthetic.md +23 -0
- package/docs/plugins/reference/tavily.md +23 -0
- package/docs/plugins/reference/telegram.md +23 -0
- package/docs/plugins/reference/tencent.md +23 -0
- package/docs/plugins/reference/tlon.md +23 -0
- package/docs/plugins/reference/together.md +23 -0
- package/docs/plugins/reference/tokenjuice.md +23 -0
- package/docs/plugins/reference/tts-local-cli.md +19 -0
- package/docs/plugins/reference/twitch.md +23 -0
- package/docs/plugins/reference/venice.md +23 -0
- package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
- package/docs/plugins/reference/vllm.md +23 -0
- package/docs/plugins/reference/voice-call.md +23 -0
- package/docs/plugins/reference/volcengine.md +23 -0
- package/docs/plugins/reference/voyage.md +19 -0
- package/docs/plugins/reference/vydra.md +23 -0
- package/docs/plugins/reference/web-readability.md +19 -0
- package/docs/plugins/reference/webhooks.md +23 -0
- package/docs/plugins/reference/whatsapp.md +23 -0
- package/docs/plugins/reference/xai.md +23 -0
- package/docs/plugins/reference/xiaomi.md +23 -0
- package/docs/plugins/reference/zai.md +23 -0
- package/docs/plugins/reference/zalo.md +23 -0
- package/docs/plugins/reference/zalouser.md +24 -0
- package/docs/plugins/reference.md +138 -0
- package/docs/plugins/sdk-agent-harness.md +339 -0
- package/docs/plugins/sdk-channel-ingress.md +137 -0
- package/docs/plugins/sdk-channel-message.md +458 -0
- package/docs/plugins/sdk-channel-plugins.md +762 -0
- package/docs/plugins/sdk-channel-turn.md +580 -0
- package/docs/plugins/sdk-entrypoints.md +333 -0
- package/docs/plugins/sdk-migration.md +949 -0
- package/docs/plugins/sdk-overview.md +501 -0
- package/docs/plugins/sdk-provider-plugins.md +807 -0
- package/docs/plugins/sdk-runtime.md +676 -0
- package/docs/plugins/sdk-setup.md +550 -0
- package/docs/plugins/sdk-subpaths.md +396 -0
- package/docs/plugins/sdk-testing.md +401 -0
- package/docs/plugins/skill-workshop.md +713 -0
- package/docs/plugins/tool-plugins.md +411 -0
- package/docs/plugins/voice-call.md +943 -0
- package/docs/plugins/webhooks.md +192 -0
- package/docs/plugins/zalouser.md +86 -0
- package/docs/prose.md +137 -0
- package/docs/providers/alibaba.md +158 -0
- package/docs/providers/anthropic.md +344 -0
- package/docs/providers/arcee.md +144 -0
- package/docs/providers/azure-speech.md +119 -0
- package/docs/providers/bedrock-mantle.md +211 -0
- package/docs/providers/bedrock.md +414 -0
- package/docs/providers/cerebras.md +130 -0
- package/docs/providers/chutes.md +153 -0
- package/docs/providers/claude-max-api-proxy.md +188 -0
- package/docs/providers/cloudflare-ai-gateway.md +119 -0
- package/docs/providers/comfy.md +362 -0
- package/docs/providers/deepgram.md +184 -0
- package/docs/providers/deepinfra.md +87 -0
- package/docs/providers/deepseek.md +146 -0
- package/docs/providers/ds4.md +309 -0
- package/docs/providers/elevenlabs.md +130 -0
- package/docs/providers/fal.md +204 -0
- package/docs/providers/fireworks.md +144 -0
- package/docs/providers/github-copilot.md +225 -0
- package/docs/providers/glm.md +137 -0
- package/docs/providers/google.md +472 -0
- package/docs/providers/gradium.md +123 -0
- package/docs/providers/groq.md +180 -0
- package/docs/providers/huggingface.md +235 -0
- package/docs/providers/index.md +102 -0
- package/docs/providers/inferrs.md +272 -0
- package/docs/providers/inworld.md +120 -0
- package/docs/providers/kilocode.md +135 -0
- package/docs/providers/litellm.md +234 -0
- package/docs/providers/lmstudio.md +224 -0
- package/docs/providers/minimax.md +505 -0
- package/docs/providers/mistral.md +235 -0
- package/docs/providers/models.md +65 -0
- package/docs/providers/moonshot.md +413 -0
- package/docs/providers/nvidia.md +140 -0
- package/docs/providers/ollama.md +1180 -0
- package/docs/providers/openai.md +1057 -0
- package/docs/providers/opencode-go.md +123 -0
- package/docs/providers/opencode.md +149 -0
- package/docs/providers/openrouter.md +349 -0
- package/docs/providers/perplexity-provider.md +123 -0
- package/docs/providers/qianfan.md +132 -0
- package/docs/providers/qwen.md +332 -0
- package/docs/providers/runway.md +103 -0
- package/docs/providers/senseaudio.md +68 -0
- package/docs/providers/sglang.md +161 -0
- package/docs/providers/stepfun.md +229 -0
- package/docs/providers/synthetic.md +154 -0
- package/docs/providers/tencent.md +130 -0
- package/docs/providers/together.md +141 -0
- package/docs/providers/venice.md +315 -0
- package/docs/providers/vercel-ai-gateway.md +128 -0
- package/docs/providers/vllm.md +383 -0
- package/docs/providers/volcengine.md +199 -0
- package/docs/providers/vydra.md +180 -0
- package/docs/providers/xai.md +560 -0
- package/docs/providers/xiaomi.md +188 -0
- package/docs/providers/zai.md +203 -0
- package/docs/refactor/access.md +9 -0
- package/docs/refactor/acp.md +298 -0
- package/docs/refactor/canvas.md +131 -0
- package/docs/refactor/ingress-core.md +341 -0
- package/docs/reference/AGENTS.default.md +129 -0
- package/docs/reference/RELEASING.md +767 -0
- package/docs/reference/api-usage-costs.md +202 -0
- package/docs/reference/application-modernization-plan.md +208 -0
- package/docs/reference/code-mode.md +757 -0
- package/docs/reference/credits.md +33 -0
- package/docs/reference/device-models.md +50 -0
- package/docs/reference/full-release-validation.md +202 -0
- package/docs/reference/memory-config.md +630 -0
- package/docs/reference/openclaw-sdk-api-design.md +390 -0
- package/docs/reference/prompt-caching.md +358 -0
- package/docs/reference/rich-output-protocol.md +79 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secretref-credential-surface.md +159 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +663 -0
- package/docs/reference/session-management-compaction.md +461 -0
- package/docs/reference/templates/AGENTS.dev.md +89 -0
- package/docs/reference/templates/AGENTS.md +225 -0
- package/docs/reference/templates/BOOT.md +16 -0
- package/docs/reference/templates/BOOTSTRAP.md +66 -0
- package/docs/reference/templates/HEARTBEAT.md +16 -0
- package/docs/reference/templates/IDENTITY.dev.md +52 -0
- package/docs/reference/templates/IDENTITY.md +34 -0
- package/docs/reference/templates/SOUL.dev.md +82 -0
- package/docs/reference/templates/SOUL.md +49 -0
- package/docs/reference/templates/TOOLS.dev.md +29 -0
- package/docs/reference/templates/TOOLS.md +51 -0
- package/docs/reference/templates/USER.dev.md +23 -0
- package/docs/reference/templates/USER.md +28 -0
- package/docs/reference/test.md +239 -0
- package/docs/reference/token-use.md +233 -0
- package/docs/reference/transcript-hygiene.md +214 -0
- package/docs/reference/wizard.md +252 -0
- package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
- package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
- package/docs/security/formal-verification.md +170 -0
- package/docs/security/incident-response.md +59 -0
- package/docs/security/network-proxy.md +268 -0
- package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
- package/docs/snippets/plugin-publish/minimal-package.json +16 -0
- package/docs/start/bootstrapping.md +49 -0
- package/docs/start/docs-directory.md +69 -0
- package/docs/start/getting-started.md +152 -0
- package/docs/start/hubs.md +201 -0
- package/docs/start/lore.md +223 -0
- package/docs/start/onboarding-overview.md +72 -0
- package/docs/start/onboarding.md +95 -0
- package/docs/start/openclaw.md +244 -0
- package/docs/start/quickstart.md +25 -0
- package/docs/start/setup.md +178 -0
- package/docs/start/showcase.md +383 -0
- package/docs/start/wizard-cli-automation.md +232 -0
- package/docs/start/wizard-cli-reference.md +331 -0
- package/docs/start/wizard.md +141 -0
- package/docs/style.css +184 -0
- package/docs/superpowers/specs/2026-04-22-tweakcn-custom-theme-import-design.md +316 -0
- package/docs/tools/acp-agents-setup.md +352 -0
- package/docs/tools/acp-agents.md +847 -0
- package/docs/tools/agent-send.md +112 -0
- package/docs/tools/apply-patch.md +64 -0
- package/docs/tools/brave-search.md +139 -0
- package/docs/tools/browser-control.md +391 -0
- package/docs/tools/browser-linux-troubleshooting.md +173 -0
- package/docs/tools/browser-login.md +77 -0
- package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
- package/docs/tools/browser.md +769 -0
- package/docs/tools/btw.md +159 -0
- package/docs/tools/capability-cookbook.md +12 -0
- package/docs/tools/clawhub.md +5 -0
- package/docs/tools/code-execution.md +173 -0
- package/docs/tools/creating-skills.md +120 -0
- package/docs/tools/diffs.md +506 -0
- package/docs/tools/duckduckgo-search.md +109 -0
- package/docs/tools/elevated.md +128 -0
- package/docs/tools/exa-search.md +152 -0
- package/docs/tools/exec-approvals-advanced.md +360 -0
- package/docs/tools/exec-approvals.md +474 -0
- package/docs/tools/exec.md +282 -0
- package/docs/tools/firecrawl.md +155 -0
- package/docs/tools/gemini-search.md +114 -0
- package/docs/tools/grok-search.md +113 -0
- package/docs/tools/image-generation.md +433 -0
- package/docs/tools/index.md +178 -0
- package/docs/tools/kimi-search.md +105 -0
- package/docs/tools/llm-task.md +137 -0
- package/docs/tools/lobster.md +365 -0
- package/docs/tools/loop-detection.md +154 -0
- package/docs/tools/media-overview.md +157 -0
- package/docs/tools/minimax-search.md +102 -0
- package/docs/tools/multi-agent-sandbox-tools.md +409 -0
- package/docs/tools/music-generation.md +371 -0
- package/docs/tools/ollama-search.md +153 -0
- package/docs/tools/pdf.md +195 -0
- package/docs/tools/perplexity-search.md +220 -0
- package/docs/tools/plugin.md +327 -0
- package/docs/tools/reactions.md +100 -0
- package/docs/tools/searxng-search.md +141 -0
- package/docs/tools/skills-config.md +195 -0
- package/docs/tools/skills.md +535 -0
- package/docs/tools/slash-commands.md +488 -0
- package/docs/tools/steer.md +84 -0
- package/docs/tools/subagents.md +650 -0
- package/docs/tools/tavily.md +162 -0
- package/docs/tools/thinking.md +140 -0
- package/docs/tools/tokenjuice.md +81 -0
- package/docs/tools/tool-search.md +269 -0
- package/docs/tools/trajectory.md +229 -0
- package/docs/tools/tts.md +1004 -0
- package/docs/tools/video-generation.md +552 -0
- package/docs/tools/web-fetch.md +195 -0
- package/docs/tools/web.md +459 -0
- package/docs/tts.md +11 -0
- package/docs/vps.md +139 -0
- package/docs/web/control-ui.md +503 -0
- package/docs/web/dashboard.md +107 -0
- package/docs/web/index.md +133 -0
- package/docs/web/tui.md +246 -0
- package/docs/web/webchat.md +99 -0
- package/docs/whatsapp-openclaw-ai-zh.jpg +0 -0
- package/docs/whatsapp-openclaw.jpg +0 -0
- package/nodmix.mjs +487 -0
- package/package.json +1852 -0
- package/patches/.gitkeep +0 -0
- package/patches/@agentclientprotocol__claude-agent-acp@0.36.1.patch +41 -0
- package/pnpm-workspace.yaml +63 -0
- package/scripts/crabbox-wrapper.mjs +353 -0
- package/scripts/lib/official-external-channel-catalog.json +559 -0
- package/scripts/lib/official-external-plugin-catalog.json +192 -0
- package/scripts/lib/official-external-provider-catalog.json +117 -0
- package/scripts/lib/package-dist-imports.mjs +171 -0
- package/scripts/npm-runner.mjs +91 -0
- package/scripts/postinstall-bundled-plugins.mjs +978 -0
- package/scripts/preinstall-package-manager-warning.mjs +64 -0
- package/scripts/windows-cmd-helpers.mjs +20 -0
- package/skills/1password/SKILL.md +70 -0
- package/skills/1password/references/cli-examples.md +29 -0
- package/skills/1password/references/get-started.md +17 -0
- package/skills/apple-notes/SKILL.md +77 -0
- package/skills/apple-reminders/SKILL.md +118 -0
- package/skills/bear-notes/SKILL.md +107 -0
- package/skills/blogwatcher/SKILL.md +69 -0
- package/skills/blucli/SKILL.md +47 -0
- package/skills/camsnap/SKILL.md +45 -0
- package/skills/canvas/SKILL.md +78 -0
- package/skills/clawhub/SKILL.md +77 -0
- package/skills/coding-agent/SKILL.md +149 -0
- package/skills/diagram-maker/SKILL.md +53 -0
- package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
- package/skills/diagram-maker/references/svg-template.md +112 -0
- package/skills/discord/SKILL.md +136 -0
- package/skills/eightctl/SKILL.md +50 -0
- package/skills/gemini/SKILL.md +47 -0
- package/skills/gh-issues/SKILL.md +213 -0
- package/skills/gifgrep/SKILL.md +85 -0
- package/skills/github/SKILL.md +84 -0
- package/skills/gog/SKILL.md +116 -0
- package/skills/goplaces/SKILL.md +52 -0
- package/skills/healthcheck/SKILL.md +105 -0
- package/skills/himalaya/SKILL.md +80 -0
- package/skills/himalaya/references/configuration.md +184 -0
- package/skills/himalaya/references/message-composition.md +199 -0
- package/skills/imsg/SKILL.md +122 -0
- package/skills/mcporter/SKILL.md +61 -0
- package/skills/meme-maker/SKILL.md +42 -0
- package/skills/meme-maker/references/templates.json +358 -0
- package/skills/meme-maker/scripts/meme.mjs +398 -0
- package/skills/model-usage/SKILL.md +69 -0
- package/skills/model-usage/references/codexbar-cli.md +33 -0
- package/skills/model-usage/scripts/model_usage.py +319 -0
- package/skills/model-usage/scripts/test_model_usage.py +40 -0
- package/skills/nano-pdf/SKILL.md +38 -0
- package/skills/node-connect/SKILL.md +142 -0
- package/skills/node-inspect-debugger/SKILL.md +85 -0
- package/skills/notion/SKILL.md +150 -0
- package/skills/obsidian/SKILL.md +119 -0
- package/skills/openai-whisper/SKILL.md +38 -0
- package/skills/openai-whisper-api/SKILL.md +71 -0
- package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
- package/skills/openhue/SKILL.md +112 -0
- package/skills/oracle/SKILL.md +126 -0
- package/skills/ordercli/SKILL.md +78 -0
- package/skills/peekaboo/SKILL.md +190 -0
- package/skills/pyproject.toml +10 -0
- package/skills/python-debugpy/SKILL.md +73 -0
- package/skills/sag/SKILL.md +87 -0
- package/skills/session-logs/SKILL.md +151 -0
- package/skills/sherpa-onnx-tts/SKILL.md +109 -0
- package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
- package/skills/skill-creator/SKILL.md +78 -0
- package/skills/skill-creator/license.txt +202 -0
- package/skills/skill-creator/scripts/init_skill.py +378 -0
- package/skills/skill-creator/scripts/package_skill.py +139 -0
- package/skills/skill-creator/scripts/quick_validate.py +169 -0
- package/skills/skill-creator/scripts/test_package_skill.py +161 -0
- package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
- package/skills/slack/SKILL.md +78 -0
- package/skills/songsee/SKILL.md +49 -0
- package/skills/sonoscli/SKILL.md +65 -0
- package/skills/spike/SKILL.md +51 -0
- package/skills/spotify-player/SKILL.md +64 -0
- package/skills/summarize/SKILL.md +87 -0
- package/skills/taskflow/SKILL.md +149 -0
- package/skills/taskflow/examples/inbox-triage.lobster +33 -0
- package/skills/taskflow/examples/pr-intake.lobster +32 -0
- package/skills/taskflow-inbox-triage/SKILL.md +119 -0
- package/skills/things-mac/SKILL.md +86 -0
- package/skills/tmux/SKILL.md +91 -0
- package/skills/tmux/scripts/find-sessions.sh +112 -0
- package/skills/tmux/scripts/wait-for-text.sh +83 -0
- package/skills/trello/SKILL.md +108 -0
- package/skills/video-frames/SKILL.md +46 -0
- package/skills/video-frames/scripts/frame.sh +81 -0
- package/skills/voice-call/SKILL.md +45 -0
- package/skills/wacli/SKILL.md +72 -0
- package/skills/weather/SKILL.md +64 -0
- package/skills/xurl/SKILL.md +120 -0
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Message flow, sessions, queueing, and reasoning visibility"
|
|
3
|
+
read_when:
|
|
4
|
+
- Explaining how inbound messages become replies
|
|
5
|
+
- Clarifying sessions, queueing modes, or streaming behavior
|
|
6
|
+
- Documenting reasoning visibility and usage implications
|
|
7
|
+
title: "Messages"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Nodmix handles inbound messages through a pipeline of session resolution, queueing, streaming, tool execution, and reasoning visibility. This page maps the path from inbound message to reply.
|
|
11
|
+
|
|
12
|
+
## Message flow (high level)
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
Inbound message
|
|
16
|
+
-> routing/bindings -> session key
|
|
17
|
+
-> queue (if a run is active)
|
|
18
|
+
-> agent run (streaming + tools)
|
|
19
|
+
-> outbound replies (channel limits + chunking)
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Key knobs live in configuration:
|
|
23
|
+
|
|
24
|
+
- `messages.*` for prefixes, queueing, and group behavior.
|
|
25
|
+
- `agents.defaults.*` for block streaming and chunking defaults.
|
|
26
|
+
- Channel overrides (`channels.whatsapp.*`, `channels.telegram.*`, etc.) for caps and streaming toggles.
|
|
27
|
+
|
|
28
|
+
See [Configuration](/gateway/configuration) for full schema.
|
|
29
|
+
|
|
30
|
+
## Inbound dedupe
|
|
31
|
+
|
|
32
|
+
Channels can redeliver the same message after reconnects. Nodmix keeps a
|
|
33
|
+
short-lived cache keyed by channel/account/peer/session/message id so duplicate
|
|
34
|
+
deliveries do not trigger another agent run.
|
|
35
|
+
|
|
36
|
+
## Inbound debouncing
|
|
37
|
+
|
|
38
|
+
Rapid consecutive messages from the **same sender** can be batched into a single
|
|
39
|
+
agent turn via `messages.inbound`. Debouncing is scoped per channel + conversation
|
|
40
|
+
and uses the most recent message for reply threading/IDs.
|
|
41
|
+
|
|
42
|
+
Config (global default + per-channel overrides):
|
|
43
|
+
|
|
44
|
+
```json5
|
|
45
|
+
{
|
|
46
|
+
messages: {
|
|
47
|
+
inbound: {
|
|
48
|
+
debounceMs: 2000,
|
|
49
|
+
byChannel: {
|
|
50
|
+
whatsapp: 5000,
|
|
51
|
+
slack: 1500,
|
|
52
|
+
discord: 1500,
|
|
53
|
+
},
|
|
54
|
+
},
|
|
55
|
+
},
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Notes:
|
|
60
|
+
|
|
61
|
+
- Debounce applies to **text-only** messages; media/attachments flush immediately.
|
|
62
|
+
- Control commands bypass debouncing so they remain standalone. Channels that explicitly opt in to same-sender DM coalescing can keep DM commands inside the debounce window so a split-send payload can join the same agent turn.
|
|
63
|
+
|
|
64
|
+
## Sessions and devices
|
|
65
|
+
|
|
66
|
+
Sessions are owned by the gateway, not by clients.
|
|
67
|
+
|
|
68
|
+
- Direct chats collapse into the agent main session key.
|
|
69
|
+
- Groups/channels get their own session keys.
|
|
70
|
+
- The session store and transcripts live on the gateway host.
|
|
71
|
+
|
|
72
|
+
Multiple devices/channels can map to the same session, but history is not fully
|
|
73
|
+
synced back to every client. Recommendation: use one primary device for long
|
|
74
|
+
conversations to avoid divergent context. The Control UI and TUI always show the
|
|
75
|
+
gateway-backed session transcript, so they are the source of truth.
|
|
76
|
+
|
|
77
|
+
Details: [Session management](/concepts/session).
|
|
78
|
+
|
|
79
|
+
## Tool result metadata
|
|
80
|
+
|
|
81
|
+
Tool result `content` is the model-visible result. Tool result `details` is
|
|
82
|
+
runtime metadata for UI rendering, diagnostics, media delivery, and plugins.
|
|
83
|
+
|
|
84
|
+
Nodmix keeps that boundary explicit:
|
|
85
|
+
|
|
86
|
+
- `toolResult.details` is stripped before provider replay and compaction input.
|
|
87
|
+
- Persisted session transcripts keep only bounded `details`; oversized metadata
|
|
88
|
+
is replaced with a compact summary marked `persistedDetailsTruncated: true`.
|
|
89
|
+
- Plugins and tools should put text the model must read in `content`, not only
|
|
90
|
+
in `details`.
|
|
91
|
+
|
|
92
|
+
## Inbound bodies and history context
|
|
93
|
+
|
|
94
|
+
Nodmix separates the **prompt body** from the **command body**:
|
|
95
|
+
|
|
96
|
+
- `BodyForAgent`: primary model-facing text for the current message. Channel
|
|
97
|
+
plugins should keep this focused on the sender's current prompt-bearing text.
|
|
98
|
+
- `Body`: legacy prompt fallback. This may include channel envelopes and
|
|
99
|
+
optional history wrappers, but current channels should not rely on it as the
|
|
100
|
+
primary model input when `BodyForAgent` is available.
|
|
101
|
+
- `CommandBody`: raw user text for directive/command parsing.
|
|
102
|
+
- `RawBody`: legacy alias for `CommandBody` (kept for compatibility).
|
|
103
|
+
|
|
104
|
+
When a channel supplies history, it uses a shared wrapper:
|
|
105
|
+
|
|
106
|
+
- `[Chat messages since your last reply - for context]`
|
|
107
|
+
- `[Current message - respond to this]`
|
|
108
|
+
|
|
109
|
+
For **non-direct chats** (groups/channels/rooms), the **current message body** is prefixed with the
|
|
110
|
+
sender label (same style used for history entries). This keeps real-time and queued/history
|
|
111
|
+
messages consistent in the agent prompt.
|
|
112
|
+
|
|
113
|
+
History buffers are **pending-only**: they include group messages that did _not_
|
|
114
|
+
trigger a run (for example, mention-gated messages) and **exclude** messages
|
|
115
|
+
already in the session transcript.
|
|
116
|
+
|
|
117
|
+
Directive stripping only applies to the **current message** section so history
|
|
118
|
+
remains intact. Channels that wrap history should set `CommandBody` (or
|
|
119
|
+
`RawBody`) to the original message text and keep `Body` as the combined prompt.
|
|
120
|
+
Structured history, reply, forwarded, and channel metadata are rendered as
|
|
121
|
+
user-role untrusted context blocks during prompt assembly.
|
|
122
|
+
History buffers are configurable via `messages.groupChat.historyLimit` (global
|
|
123
|
+
default) and per-channel overrides like `channels.slack.historyLimit` or
|
|
124
|
+
`channels.telegram.accounts.<id>.historyLimit` (set `0` to disable).
|
|
125
|
+
|
|
126
|
+
## Queueing and followups
|
|
127
|
+
|
|
128
|
+
If a run is already active, inbound messages are steered into the current run by
|
|
129
|
+
default. `messages.queue` selects whether active-run messages steer, queue for
|
|
130
|
+
later, collect into one later turn, or interrupt the active run.
|
|
131
|
+
|
|
132
|
+
- Configure via `messages.queue` (and `messages.queue.byChannel`).
|
|
133
|
+
- Default mode is `steer`, with a 500ms debounce for Codex steering batches and
|
|
134
|
+
followup/collect queues.
|
|
135
|
+
- Modes: `steer`, `followup`, `collect`, and `interrupt`.
|
|
136
|
+
|
|
137
|
+
Details: [Command queue](/concepts/queue) and [Steering queue](/concepts/queue-steering).
|
|
138
|
+
|
|
139
|
+
## Channel run ownership
|
|
140
|
+
|
|
141
|
+
Channel plugins may preserve ordering, debounce input, and apply transport
|
|
142
|
+
backpressure before a message enters the session queue. They should not impose a
|
|
143
|
+
separate timeout around the agent turn itself. Once a message is routed to a
|
|
144
|
+
session, long-running work is governed by the session, tool, and runtime
|
|
145
|
+
lifecycle so all channels report and recover from slow turns consistently.
|
|
146
|
+
|
|
147
|
+
## Streaming, chunking, and batching
|
|
148
|
+
|
|
149
|
+
Block streaming sends partial replies as the model produces text blocks.
|
|
150
|
+
Chunking respects channel text limits and avoids splitting fenced code.
|
|
151
|
+
|
|
152
|
+
Key settings:
|
|
153
|
+
|
|
154
|
+
- `agents.defaults.blockStreamingDefault` (`on|off`, default off)
|
|
155
|
+
- `agents.defaults.blockStreamingBreak` (`text_end|message_end`)
|
|
156
|
+
- `agents.defaults.blockStreamingChunk` (`minChars|maxChars|breakPreference`)
|
|
157
|
+
- `agents.defaults.blockStreamingCoalesce` (idle-based batching)
|
|
158
|
+
- `agents.defaults.humanDelay` (human-like pause between block replies)
|
|
159
|
+
- Channel overrides: `*.blockStreaming` and `*.blockStreamingCoalesce` (non-Telegram channels require explicit `*.blockStreaming: true`)
|
|
160
|
+
|
|
161
|
+
Details: [Streaming + chunking](/concepts/streaming).
|
|
162
|
+
|
|
163
|
+
## Reasoning visibility and tokens
|
|
164
|
+
|
|
165
|
+
Nodmix can expose or hide model reasoning:
|
|
166
|
+
|
|
167
|
+
- `/reasoning on|off|stream` controls visibility.
|
|
168
|
+
- Reasoning content still counts toward token usage when produced by the model.
|
|
169
|
+
- Telegram supports reasoning stream into a transient draft bubble that is deleted after final delivery; use `/reasoning on` for persistent reasoning output.
|
|
170
|
+
|
|
171
|
+
Details: [Thinking + reasoning directives](/tools/thinking) and [Token use](/reference/token-use).
|
|
172
|
+
|
|
173
|
+
## Prefixes, threading, and replies
|
|
174
|
+
|
|
175
|
+
Outbound message formatting is centralized in `messages`:
|
|
176
|
+
|
|
177
|
+
- `messages.responsePrefix`, `channels.<channel>.responsePrefix`, and `channels.<channel>.accounts.<id>.responsePrefix` (outbound prefix cascade), plus `channels.whatsapp.messagePrefix` (WhatsApp inbound prefix)
|
|
178
|
+
- Reply threading via `replyToMode` and per-channel defaults
|
|
179
|
+
|
|
180
|
+
Details: [Configuration](/gateway/config-agents#messages) and channel docs.
|
|
181
|
+
|
|
182
|
+
## Silent replies
|
|
183
|
+
|
|
184
|
+
The exact silent token `NO_REPLY` / `no_reply` means "do not deliver a user-visible reply".
|
|
185
|
+
When a turn also has pending tool media, such as generated TTS audio, Nodmix
|
|
186
|
+
strips the silent text but still delivers the media attachment.
|
|
187
|
+
Nodmix resolves that behavior by conversation type:
|
|
188
|
+
|
|
189
|
+
- Direct conversations never receive `NO_REPLY` prompt guidance. If a direct
|
|
190
|
+
run accidentally returns a bare silent token, Nodmix suppresses it instead
|
|
191
|
+
of rewriting or delivering it.
|
|
192
|
+
- Groups/channels allow silence by default only for automatic group replies.
|
|
193
|
+
In `message_tool` visible-reply mode, silence means the model does not call
|
|
194
|
+
`message(action=send)`.
|
|
195
|
+
- Internal orchestration allows silence by default.
|
|
196
|
+
|
|
197
|
+
Nodmix also uses silent replies for internal runner failures that happen
|
|
198
|
+
before any assistant reply in non-direct chats, so groups/channels do not see
|
|
199
|
+
gateway error boilerplate. Direct chats show compact failure copy by default;
|
|
200
|
+
raw runner details are shown only when `/verbose full` is enabled.
|
|
201
|
+
|
|
202
|
+
Defaults live under `agents.defaults.silentReply`; `surfaces.<id>.silentReply`
|
|
203
|
+
can override group/internal policy per surface.
|
|
204
|
+
|
|
205
|
+
Bare silent replies are dropped on all surfaces, so parent sessions stay quiet
|
|
206
|
+
instead of rewriting sentinel text into fallback chatter.
|
|
207
|
+
|
|
208
|
+
## Related
|
|
209
|
+
|
|
210
|
+
- [Message lifecycle refactor](/concepts/message-lifecycle-refactor) - target durable send and receive design
|
|
211
|
+
- [Streaming](/concepts/streaming) — real-time message delivery
|
|
212
|
+
- [Retry](/concepts/retry) — message delivery retry behavior
|
|
213
|
+
- [Queue](/concepts/queue) — message processing queue
|
|
214
|
+
- [Channels](/channels) — messaging platform integrations
|
|
@@ -0,0 +1,385 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "How Nodmix rotates auth profiles and falls back across models"
|
|
3
|
+
read_when:
|
|
4
|
+
- Diagnosing auth profile rotation, cooldowns, or model fallback behavior
|
|
5
|
+
- Updating failover rules for auth profiles or models
|
|
6
|
+
- Understanding how session model overrides interact with fallback retries
|
|
7
|
+
title: "Model failover"
|
|
8
|
+
sidebarTitle: "Model failover"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Nodmix handles failures in two stages:
|
|
12
|
+
|
|
13
|
+
1. **Auth profile rotation** within the current provider.
|
|
14
|
+
2. **Model fallback** to the next model in `agents.defaults.model.fallbacks`.
|
|
15
|
+
|
|
16
|
+
This doc explains the runtime rules and the data that backs them.
|
|
17
|
+
|
|
18
|
+
## Runtime flow
|
|
19
|
+
|
|
20
|
+
For a normal text run, Nodmix evaluates candidates in this order:
|
|
21
|
+
|
|
22
|
+
<Steps>
|
|
23
|
+
<Step title="Resolve session state">
|
|
24
|
+
Resolve the active session model and auth-profile preference.
|
|
25
|
+
</Step>
|
|
26
|
+
<Step title="Build candidate chain">
|
|
27
|
+
Build the model candidate chain from the current model selection and the fallback policy for that selection source. Configured defaults, cron job primaries, and auto-selected fallback models can use configured fallbacks; explicit user session selections are strict.
|
|
28
|
+
</Step>
|
|
29
|
+
<Step title="Try the current provider">
|
|
30
|
+
Try the current provider with auth-profile rotation/cooldown rules.
|
|
31
|
+
</Step>
|
|
32
|
+
<Step title="Advance on failover-worthy errors">
|
|
33
|
+
If that provider is exhausted with a failover-worthy error, move to the next model candidate.
|
|
34
|
+
</Step>
|
|
35
|
+
<Step title="Persist fallback override">
|
|
36
|
+
Persist the selected fallback override before the retry starts so other session readers see the same provider/model the runner is about to use. The persisted model override is marked `modelOverrideSource: "auto"`.
|
|
37
|
+
</Step>
|
|
38
|
+
<Step title="Roll back narrowly on failure">
|
|
39
|
+
If the fallback candidate fails, roll back only the fallback-owned session override fields when they still match that failed candidate.
|
|
40
|
+
</Step>
|
|
41
|
+
<Step title="Throw FallbackSummaryError if exhausted">
|
|
42
|
+
If every candidate fails, throw a `FallbackSummaryError` with per-attempt detail and the soonest cooldown expiry when one is known.
|
|
43
|
+
</Step>
|
|
44
|
+
</Steps>
|
|
45
|
+
|
|
46
|
+
This is intentionally narrower than "save and restore the whole session". The reply runner only persists the model-selection fields it owns for fallback:
|
|
47
|
+
|
|
48
|
+
- `providerOverride`
|
|
49
|
+
- `modelOverride`
|
|
50
|
+
- `modelOverrideSource`
|
|
51
|
+
- `authProfileOverride`
|
|
52
|
+
- `authProfileOverrideSource`
|
|
53
|
+
- `authProfileOverrideCompactionCount`
|
|
54
|
+
|
|
55
|
+
That prevents a failed fallback retry from overwriting newer unrelated session mutations such as manual `/model` changes or session rotation updates that happened while the attempt was running.
|
|
56
|
+
|
|
57
|
+
## Selection source policy
|
|
58
|
+
|
|
59
|
+
Nodmix separates the selected provider/model from why it was selected. That source controls whether the fallback chain is allowed:
|
|
60
|
+
|
|
61
|
+
- **Configured default**: `agents.defaults.model.primary` uses `agents.defaults.model.fallbacks`.
|
|
62
|
+
- **Agent primary**: `agents.list[].model` is strict unless that agent model object includes its own `fallbacks`. Use `fallbacks: []` to make the strict behavior explicit, or provide a non-empty list to opt that agent into model fallback.
|
|
63
|
+
- **Auto fallback override**: a runtime fallback writes `providerOverride`, `modelOverride`, `modelOverrideSource: "auto"`, and the selected origin model before retrying. That auto override can keep walking the configured fallback chain without probing the primary on every message, but Nodmix periodically probes the configured origin again and clears the auto override when it recovers. `/new`, `/reset`, and `sessions.reset` also clear auto-sourced overrides. Heartbeat runs without an explicit `heartbeat.model` clear direct auto overrides when their origin no longer matches the current configured default.
|
|
64
|
+
- **User session override**: `/model`, the model picker, `session_status(model=...)`, and `sessions.patch` write `modelOverrideSource: "user"`. That is an exact session selection. If the selected provider/model fails before producing a reply, Nodmix reports the failure instead of answering from an unrelated configured fallback.
|
|
65
|
+
- **Legacy session override**: older session entries may have `modelOverride` without `modelOverrideSource`. Nodmix treats those as user overrides so an explicit old selection is not silently converted into fallback behavior.
|
|
66
|
+
- **Cron payload model**: a cron job `payload.model` / `--model` is a job primary, not a user session override. It uses configured fallbacks unless the job provides `payload.fallbacks`; `payload.fallbacks: []` makes the cron run strict.
|
|
67
|
+
|
|
68
|
+
The auto fallback primary-probe interval is five minutes and is not configurable. Nodmix remembers recent probes per session and primary model so a failing primary is not retried on every turn. Nodmix sends a visible notice when a session moves onto fallback and another notice when it returns to the selected primary; it does not repeat the notice on every sticky fallback turn.
|
|
69
|
+
|
|
70
|
+
## User-visible fallback notices
|
|
71
|
+
|
|
72
|
+
When a session moves onto an auto-selected fallback, Nodmix sends a status notice in the same reply surface:
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
↪️ Model Fallback: <fallback> (selected <primary>; <reason>)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
When a later probe succeeds and the session returns to the selected primary, Nodmix sends:
|
|
79
|
+
|
|
80
|
+
```text
|
|
81
|
+
↪️ Model Fallback cleared: <primary> (was <fallback>)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
These notices are operational messages, not assistant content. They are delivered once per state change, including side-effect-only turns when feasible, but sticky fallback turns do not repeat them. Delivery bypasses normal source-reply suppression, the notice does not consume the first assistant reply slot for threaded channels, and it is excluded from text-to-speech and commitment extraction.
|
|
85
|
+
|
|
86
|
+
## Auth storage (keys + OAuth)
|
|
87
|
+
|
|
88
|
+
Nodmix uses **auth profiles** for both API keys and OAuth tokens.
|
|
89
|
+
|
|
90
|
+
- Secrets live in `~/.nodmix/agents/<agentId>/agent/auth-profiles.json` (legacy: `~/.nodmix/agent/auth-profiles.json`).
|
|
91
|
+
- Runtime auth-routing state lives in `~/.nodmix/agents/<agentId>/agent/auth-state.json`.
|
|
92
|
+
- Config `auth.profiles` / `auth.order` are **metadata + routing only** (no secrets).
|
|
93
|
+
- Legacy import-only OAuth file: `~/.nodmix/credentials/oauth.json` (imported into `auth-profiles.json` on first use).
|
|
94
|
+
|
|
95
|
+
More detail: [OAuth](/concepts/oauth)
|
|
96
|
+
|
|
97
|
+
Credential types:
|
|
98
|
+
|
|
99
|
+
- `type: "api_key"` → `{ provider, key }`
|
|
100
|
+
- `type: "oauth"` → `{ provider, access, refresh, expires, email? }` (+ `projectId`/`enterpriseUrl` for some providers)
|
|
101
|
+
|
|
102
|
+
## Profile IDs
|
|
103
|
+
|
|
104
|
+
OAuth logins create distinct profiles so multiple accounts can coexist.
|
|
105
|
+
|
|
106
|
+
- Default: `provider:default` when no email is available.
|
|
107
|
+
- OAuth with email: `provider:<email>` (for example `google-antigravity:user@gmail.com`).
|
|
108
|
+
|
|
109
|
+
Profiles live in `~/.nodmix/agents/<agentId>/agent/auth-profiles.json` under `profiles`.
|
|
110
|
+
|
|
111
|
+
## Rotation order
|
|
112
|
+
|
|
113
|
+
When a provider has multiple profiles, Nodmix chooses an order like this:
|
|
114
|
+
|
|
115
|
+
<Steps>
|
|
116
|
+
<Step title="Explicit config">
|
|
117
|
+
`auth.order[provider]` (if set).
|
|
118
|
+
</Step>
|
|
119
|
+
<Step title="Configured profiles">
|
|
120
|
+
`auth.profiles` filtered by provider.
|
|
121
|
+
</Step>
|
|
122
|
+
<Step title="Stored profiles">
|
|
123
|
+
Entries in `auth-profiles.json` for the provider.
|
|
124
|
+
</Step>
|
|
125
|
+
</Steps>
|
|
126
|
+
|
|
127
|
+
If no explicit order is configured, Nodmix uses a round-robin order:
|
|
128
|
+
|
|
129
|
+
- **Primary key:** profile type (**OAuth before API keys**).
|
|
130
|
+
- **Secondary key:** `usageStats.lastUsed` (oldest first, within each type).
|
|
131
|
+
- **Cooldown/disabled profiles** are moved to the end, ordered by soonest expiry.
|
|
132
|
+
|
|
133
|
+
### Session stickiness (cache-friendly)
|
|
134
|
+
|
|
135
|
+
Nodmix **pins the chosen auth profile per session** to keep provider caches warm. It does **not** rotate on every request. The pinned profile is reused until:
|
|
136
|
+
|
|
137
|
+
- the session is reset (`/new` / `/reset`)
|
|
138
|
+
- a compaction completes (compaction count increments)
|
|
139
|
+
- the profile is in cooldown/disabled
|
|
140
|
+
|
|
141
|
+
Manual selection via `/model …@<profileId>` sets a **user override** for that session and is not auto-rotated until a new session starts.
|
|
142
|
+
|
|
143
|
+
<Note>
|
|
144
|
+
Auto-pinned profiles (selected by the session router) are treated as a **preference**: they are tried first, but Nodmix may rotate to another profile on rate limits/timeouts. When the original profile becomes available again, new runs can prefer it again without changing the selected model or runtime. User-pinned profiles stay locked to that profile; if it fails and model fallbacks are configured, Nodmix moves to the next model instead of switching profiles.
|
|
145
|
+
</Note>
|
|
146
|
+
|
|
147
|
+
### OpenAI Codex subscription plus API-key backup
|
|
148
|
+
|
|
149
|
+
For OpenAI agent models, auth and runtime are separate. `openai/gpt-*` stays on
|
|
150
|
+
the Codex harness while auth can rotate between a Codex subscription profile and
|
|
151
|
+
an OpenAI API-key backup.
|
|
152
|
+
|
|
153
|
+
Use `auth.order.openai` for the user-facing order:
|
|
154
|
+
|
|
155
|
+
```json5
|
|
156
|
+
{
|
|
157
|
+
auth: {
|
|
158
|
+
order: {
|
|
159
|
+
openai: ["openai-codex:user@example.com", "openai:api-key-backup"],
|
|
160
|
+
},
|
|
161
|
+
},
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Existing Codex subscription profiles may still use the legacy
|
|
166
|
+
`openai-codex:*` profile id. The ordered API-key backup can be a normal
|
|
167
|
+
`openai:*` API-key profile. When the subscription hits a Codex usage limit,
|
|
168
|
+
Nodmix records the exact reset time when Codex provides one, tries the next
|
|
169
|
+
ordered auth profile, and keeps the run inside the Codex harness. Once the reset
|
|
170
|
+
time passes, the subscription profile is eligible again and the next automatic
|
|
171
|
+
selection can return to it.
|
|
172
|
+
|
|
173
|
+
Use a user-pinned profile only when you want to force one account/key for that
|
|
174
|
+
session. User-pinned profiles are intentionally strict and do not silently jump
|
|
175
|
+
to another profile.
|
|
176
|
+
|
|
177
|
+
## Cooldowns
|
|
178
|
+
|
|
179
|
+
When a profile fails due to auth/rate-limit errors (or a timeout that looks like rate limiting), Nodmix marks it in cooldown and moves to the next profile.
|
|
180
|
+
|
|
181
|
+
<AccordionGroup>
|
|
182
|
+
<Accordion title="What lands in the rate-limit / timeout bucket">
|
|
183
|
+
That rate-limit bucket is broader than plain `429`: it also includes provider messages such as `Too many concurrent requests`, `ThrottlingException`, `concurrency limit reached`, `workers_ai ... quota limit exceeded`, `throttled`, `resource exhausted`, and periodic usage-window limits such as `weekly/monthly limit reached`.
|
|
184
|
+
|
|
185
|
+
Format/invalid-request errors are usually terminal because retrying the same payload would fail the same way, so Nodmix surfaces them instead of rotating auth profiles. Known retry-repair paths can opt in explicitly: for example Cloud Code Assist tool call ID validation failures are sanitized and retried once through the `allowFormatRetry` policy. OpenAI-compatible stop-reason errors such as `Unhandled stop reason: error`, `stop reason: error`, and `reason: error` are classified as timeout/failover signals.
|
|
186
|
+
|
|
187
|
+
Generic server text can also land in that timeout bucket when the source matches a known transient pattern. For example, the bare pi-ai stream-wrapper message `An unknown error occurred` is treated as failover-worthy for every provider because pi-ai emits it when provider streams end with `stopReason: "aborted"` or `stopReason: "error"` without specific details. JSON `api_error` payloads with transient server text such as `internal server error`, `unknown error, 520`, `upstream error`, or `backend error` are also treated as failover-worthy timeouts.
|
|
188
|
+
|
|
189
|
+
OpenRouter-specific generic upstream text such as bare `Provider returned error` is treated as timeout only when the provider context is actually OpenRouter. Generic internal fallback text such as `LLM request failed with an unknown error.` stays conservative and does not trigger failover by itself.
|
|
190
|
+
|
|
191
|
+
</Accordion>
|
|
192
|
+
<Accordion title="SDK retry-after caps">
|
|
193
|
+
Some provider SDKs may otherwise sleep for a long `Retry-After` window before returning control to Nodmix. For Stainless-based SDKs such as Anthropic and OpenAI, Nodmix caps SDK-internal `retry-after-ms` / `retry-after` waits at 60 seconds by default and surfaces longer retryable responses immediately so this failover path can run. Tune or disable the cap with `NODMIX_SDK_RETRY_MAX_WAIT_SECONDS`; see [Retry behavior](/concepts/retry).
|
|
194
|
+
</Accordion>
|
|
195
|
+
<Accordion title="Model-scoped cooldowns">
|
|
196
|
+
Rate-limit cooldowns can also be model-scoped:
|
|
197
|
+
|
|
198
|
+
- Nodmix records `cooldownModel` for rate-limit failures when the failing model id is known.
|
|
199
|
+
- A sibling model on the same provider can still be tried when the cooldown is scoped to a different model.
|
|
200
|
+
- Billing/disabled windows still block the whole profile across models.
|
|
201
|
+
|
|
202
|
+
</Accordion>
|
|
203
|
+
</AccordionGroup>
|
|
204
|
+
|
|
205
|
+
Cooldowns use exponential backoff:
|
|
206
|
+
|
|
207
|
+
- 1 minute
|
|
208
|
+
- 5 minutes
|
|
209
|
+
- 25 minutes
|
|
210
|
+
- 1 hour (cap)
|
|
211
|
+
|
|
212
|
+
State is stored in `auth-state.json` under `usageStats`:
|
|
213
|
+
|
|
214
|
+
```json
|
|
215
|
+
{
|
|
216
|
+
"usageStats": {
|
|
217
|
+
"provider:profile": {
|
|
218
|
+
"lastUsed": 1736160000000,
|
|
219
|
+
"cooldownUntil": 1736160600000,
|
|
220
|
+
"errorCount": 2
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## Billing disables
|
|
227
|
+
|
|
228
|
+
Billing/credit failures (for example "insufficient credits" / "credit balance too low") are treated as failover-worthy, but they're usually not transient. Instead of a short cooldown, Nodmix marks the profile as **disabled** (with a longer backoff) and rotates to the next profile/provider.
|
|
229
|
+
|
|
230
|
+
<Note>
|
|
231
|
+
Not every billing-shaped response is `402`, and not every HTTP `402` lands here. Nodmix keeps explicit billing text in the billing lane even when a provider returns `401` or `403` instead, but provider-specific matchers stay scoped to the provider that owns them (for example OpenRouter `403 Key limit exceeded`).
|
|
232
|
+
|
|
233
|
+
Meanwhile temporary `402` usage-window and organization/workspace spend-limit errors are classified as `rate_limit` when the message looks retryable (for example `weekly usage limit exhausted`, `daily limit reached, resets tomorrow`, or `organization spending limit exceeded`). Those stay on the short cooldown/failover path instead of the long billing-disable path.
|
|
234
|
+
</Note>
|
|
235
|
+
|
|
236
|
+
State is stored in `auth-state.json`:
|
|
237
|
+
|
|
238
|
+
```json
|
|
239
|
+
{
|
|
240
|
+
"usageStats": {
|
|
241
|
+
"provider:profile": {
|
|
242
|
+
"disabledUntil": 1736178000000,
|
|
243
|
+
"disabledReason": "billing"
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
Defaults:
|
|
250
|
+
|
|
251
|
+
- Billing backoff starts at **5 hours**, doubles per billing failure, and caps at **24 hours**.
|
|
252
|
+
- Backoff counters reset if the profile hasn't failed for **24 hours** (configurable).
|
|
253
|
+
- Overloaded retries allow **1 same-provider profile rotation** before model fallback.
|
|
254
|
+
- Overloaded retries use **0 ms backoff** by default.
|
|
255
|
+
|
|
256
|
+
## Model fallback
|
|
257
|
+
|
|
258
|
+
If all profiles for a provider fail, Nodmix moves to the next model in `agents.defaults.model.fallbacks`. This applies to auth failures, rate limits, and timeouts that exhausted profile rotation (other errors do not advance fallback). Provider errors that do not expose enough detail are still labeled precisely in fallback state: `empty_response` means the provider returned no usable message or status, `no_error_details` means the provider explicitly returned `Unknown error (no error details in response)`, and `unclassified` means Nodmix preserved the raw preview but no classifier matched it yet.
|
|
259
|
+
|
|
260
|
+
Overloaded and rate-limit errors are handled more aggressively than billing cooldowns. By default, Nodmix allows one same-provider auth-profile retry, then switches to the next configured model fallback without waiting. Provider-busy signals such as `ModelNotReadyException` land in that overloaded bucket. Tune this with `auth.cooldowns.overloadedProfileRotations`, `auth.cooldowns.overloadedBackoffMs`, and `auth.cooldowns.rateLimitedProfileRotations`.
|
|
261
|
+
|
|
262
|
+
When a run starts from the configured default primary, a cron job primary, an agent primary with explicit fallbacks, or an auto-selected fallback override, Nodmix can walk the matching configured fallback chain. Agent primaries without explicit fallbacks and explicit user selections (for example `/model ollama/qwen3.5:27b`, the model picker, `sessions.patch`, or one-off CLI provider/model overrides) are strict: if that provider/model is unreachable or fails before producing a reply, Nodmix reports the failure instead of answering from an unrelated fallback.
|
|
263
|
+
|
|
264
|
+
### Candidate chain rules
|
|
265
|
+
|
|
266
|
+
Nodmix builds the candidate list from the currently requested `provider/model` plus configured fallbacks.
|
|
267
|
+
|
|
268
|
+
<AccordionGroup>
|
|
269
|
+
<Accordion title="Rules">
|
|
270
|
+
- The requested model is always first.
|
|
271
|
+
- Explicit configured fallbacks are deduplicated but not filtered by the model allowlist. They are treated as explicit operator intent.
|
|
272
|
+
- If the current run is already on a configured fallback in the same provider family, Nodmix keeps using the full configured chain.
|
|
273
|
+
- When no explicit fallback override is supplied, configured fallbacks are tried before the configured primary even if the requested model uses a different provider.
|
|
274
|
+
- When no explicit fallback override is supplied to the fallback runner, the configured primary is appended at the end so the chain can settle back onto the normal default once earlier candidates are exhausted.
|
|
275
|
+
- When a caller supplies `fallbacksOverride`, the runner uses exactly the requested model plus that override list. An empty list disables model fallback and prevents the configured primary from being appended as a hidden retry target.
|
|
276
|
+
|
|
277
|
+
</Accordion>
|
|
278
|
+
</AccordionGroup>
|
|
279
|
+
|
|
280
|
+
### Which errors advance fallback
|
|
281
|
+
|
|
282
|
+
<Tabs>
|
|
283
|
+
<Tab title="Continues on">
|
|
284
|
+
- auth failures
|
|
285
|
+
- rate limits and cooldown exhaustion
|
|
286
|
+
- overloaded/provider-busy errors
|
|
287
|
+
- timeout-shaped failover errors
|
|
288
|
+
- billing disables
|
|
289
|
+
- `LiveSessionModelSwitchError`, which is normalized into a failover path so a stale persisted model does not create an outer retry loop
|
|
290
|
+
- other unrecognized errors when there are still remaining candidates
|
|
291
|
+
|
|
292
|
+
</Tab>
|
|
293
|
+
<Tab title="Does not continue on">
|
|
294
|
+
- explicit aborts that are not timeout/failover-shaped
|
|
295
|
+
- context overflow errors that should stay inside compaction/retry logic (for example `request_too_large`, `INVALID_ARGUMENT: input exceeds the maximum number of tokens`, `input token count exceeds the maximum number of input tokens`, `The input is too long for the model`, or `ollama error: context length exceeded`)
|
|
296
|
+
- a final unknown error when there are no candidates left
|
|
297
|
+
|
|
298
|
+
</Tab>
|
|
299
|
+
</Tabs>
|
|
300
|
+
|
|
301
|
+
### Cooldown skip vs probe behavior
|
|
302
|
+
|
|
303
|
+
When every auth profile for a provider is already in cooldown, Nodmix does not automatically skip that provider forever. It makes a per-candidate decision:
|
|
304
|
+
|
|
305
|
+
<AccordionGroup>
|
|
306
|
+
<Accordion title="Per-candidate decisions">
|
|
307
|
+
- Persistent auth failures skip the whole provider immediately.
|
|
308
|
+
- Billing disables usually skip, but the primary candidate can still be probed on a throttle so recovery is possible without restarting.
|
|
309
|
+
- The primary candidate may be probed near cooldown expiry, with a per-provider throttle.
|
|
310
|
+
- Same-provider fallback siblings can be attempted despite cooldown when the failure looks transient (`rate_limit`, `overloaded`, or unknown). This is especially relevant when a rate limit is model-scoped and a sibling model may still recover immediately.
|
|
311
|
+
- Transient cooldown probes are limited to one per provider per fallback run so a single provider does not stall cross-provider fallback.
|
|
312
|
+
|
|
313
|
+
</Accordion>
|
|
314
|
+
</AccordionGroup>
|
|
315
|
+
|
|
316
|
+
## Session overrides and live model switching
|
|
317
|
+
|
|
318
|
+
Session model changes are shared state. The active runner, `/model` command, compaction/session updates, and live-session reconciliation all read or write parts of the same session entry.
|
|
319
|
+
|
|
320
|
+
That means fallback retries have to coordinate with live model switching:
|
|
321
|
+
|
|
322
|
+
- Only explicit user-driven model changes mark a pending live switch. That includes `/model`, `session_status(model=...)`, and `sessions.patch`.
|
|
323
|
+
- System-driven model changes such as fallback rotation, heartbeat overrides, or compaction never mark a pending live switch on their own.
|
|
324
|
+
- User-driven model overrides are treated as exact selections for fallback policy, so an unreachable selected provider surfaces as a failure instead of being masked by `agents.defaults.model.fallbacks`.
|
|
325
|
+
- Before a fallback retry starts, the reply runner persists the selected fallback override fields to the session entry.
|
|
326
|
+
- Auto fallback overrides remain selected on subsequent turns so Nodmix does not probe a known-bad primary on every message. Nodmix periodically probes the configured origin again and clears the auto override when it recovers; `/new`, `/reset`, and `sessions.reset` clear auto-sourced overrides immediately.
|
|
327
|
+
- User replies announce fallback transitions and fallback-cleared recovery once per state change. Sticky fallback turns do not repeat the notice.
|
|
328
|
+
- `/status` shows the selected model and, when fallback state differs, the active fallback model and reason.
|
|
329
|
+
- Live-session reconciliation prefers persisted session overrides over stale runtime model fields.
|
|
330
|
+
- If a live-switch error points at a later candidate in the active fallback chain, Nodmix jumps directly to that selected model instead of walking unrelated candidates first.
|
|
331
|
+
- If the fallback attempt fails, the runner rolls back only the override fields it wrote, and only if they still match that failed candidate.
|
|
332
|
+
|
|
333
|
+
This prevents the classic race:
|
|
334
|
+
|
|
335
|
+
<Steps>
|
|
336
|
+
<Step title="Primary fails">
|
|
337
|
+
The selected primary model fails.
|
|
338
|
+
</Step>
|
|
339
|
+
<Step title="Fallback chosen in memory">
|
|
340
|
+
Fallback candidate is chosen in memory.
|
|
341
|
+
</Step>
|
|
342
|
+
<Step title="Session store still says old primary">
|
|
343
|
+
Session store still reflects the old primary.
|
|
344
|
+
</Step>
|
|
345
|
+
<Step title="Live reconciliation reads stale state">
|
|
346
|
+
Live-session reconciliation reads the stale session state.
|
|
347
|
+
</Step>
|
|
348
|
+
<Step title="Retry snapped back">
|
|
349
|
+
The retry gets snapped back to the old model before the fallback attempt starts.
|
|
350
|
+
</Step>
|
|
351
|
+
</Steps>
|
|
352
|
+
|
|
353
|
+
The persisted fallback override closes that window, and the narrow rollback keeps newer manual or runtime session changes intact.
|
|
354
|
+
|
|
355
|
+
## Observability and failure summaries
|
|
356
|
+
|
|
357
|
+
`runWithModelFallback(...)` records per-attempt details that feed logs and user-facing cooldown messaging:
|
|
358
|
+
|
|
359
|
+
- provider/model attempted
|
|
360
|
+
- reason (`rate_limit`, `overloaded`, `billing`, `auth`, `model_not_found`, and similar failover reasons)
|
|
361
|
+
- optional status/code
|
|
362
|
+
- human-readable error summary
|
|
363
|
+
|
|
364
|
+
Structured `model_fallback_decision` logs also include flat `fallbackStep*` fields when a candidate fails, is skipped, or a later fallback succeeds. These fields make the attempted transition explicit (`fallbackStepFromModel`, `fallbackStepToModel`, `fallbackStepFromFailureReason`, `fallbackStepFromFailureDetail`, `fallbackStepFinalOutcome`) so log and diagnostic exporters can reconstruct the primary failure even when the terminal fallback also fails.
|
|
365
|
+
|
|
366
|
+
When every candidate fails, Nodmix throws `FallbackSummaryError`. The outer reply runner can use that to build a more specific message such as "all models are temporarily rate-limited" and include the soonest cooldown expiry when one is known.
|
|
367
|
+
|
|
368
|
+
That cooldown summary is model-aware:
|
|
369
|
+
|
|
370
|
+
- unrelated model-scoped rate limits are ignored for the attempted provider/model chain
|
|
371
|
+
- if the remaining block is a matching model-scoped rate limit, Nodmix reports the last matching expiry that still blocks that model
|
|
372
|
+
|
|
373
|
+
## Related config
|
|
374
|
+
|
|
375
|
+
See [Gateway configuration](/gateway/configuration) for:
|
|
376
|
+
|
|
377
|
+
- `auth.profiles` / `auth.order`
|
|
378
|
+
- `auth.cooldowns.billingBackoffHours` / `auth.cooldowns.billingBackoffHoursByProvider`
|
|
379
|
+
- `auth.cooldowns.billingMaxHours` / `auth.cooldowns.failureWindowHours`
|
|
380
|
+
- `auth.cooldowns.overloadedProfileRotations` / `auth.cooldowns.overloadedBackoffMs`
|
|
381
|
+
- `auth.cooldowns.rateLimitedProfileRotations`
|
|
382
|
+
- `agents.defaults.model.primary` / `agents.defaults.model.fallbacks`
|
|
383
|
+
- `agents.defaults.imageModel` routing
|
|
384
|
+
|
|
385
|
+
See [Models](/concepts/models) for the broader model selection and fallback overview.
|