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,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Perplexity web search provider setup (API key, search modes, filtering)"
|
|
3
|
+
title: "Perplexity"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to configure Perplexity as a web search provider
|
|
6
|
+
- You need the Perplexity API key or OpenRouter proxy setup
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
The Perplexity plugin provides web search capabilities through the Perplexity
|
|
10
|
+
Search API or Perplexity Sonar via OpenRouter.
|
|
11
|
+
|
|
12
|
+
<Note>
|
|
13
|
+
This page is the Perplexity **provider** setup. For the Perplexity **tool** (how the agent uses it), see [Perplexity tool](/tools/perplexity-search).
|
|
14
|
+
</Note>
|
|
15
|
+
|
|
16
|
+
| Property | Value |
|
|
17
|
+
| ----------- | ---------------------------------------------------------------------- |
|
|
18
|
+
| Type | Web search provider (not a model provider) |
|
|
19
|
+
| Auth | `PERPLEXITY_API_KEY` (direct) or `OPENROUTER_API_KEY` (via OpenRouter) |
|
|
20
|
+
| Config path | `plugins.entries.perplexity.config.webSearch.apiKey` |
|
|
21
|
+
|
|
22
|
+
## Getting started
|
|
23
|
+
|
|
24
|
+
<Steps>
|
|
25
|
+
<Step title="Set the API key">
|
|
26
|
+
Run the interactive web-search configuration flow:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
nodmix configure --section web
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Or set the key directly:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
nodmix config set plugins.entries.perplexity.config.webSearch.apiKey "pplx-xxxxxxxxxxxx"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
</Step>
|
|
39
|
+
<Step title="Start searching">
|
|
40
|
+
The agent will automatically use Perplexity for web searches once the key is
|
|
41
|
+
configured. No additional steps are required.
|
|
42
|
+
</Step>
|
|
43
|
+
</Steps>
|
|
44
|
+
|
|
45
|
+
## Search modes
|
|
46
|
+
|
|
47
|
+
The plugin auto-selects the transport based on API key prefix:
|
|
48
|
+
|
|
49
|
+
<Tabs>
|
|
50
|
+
<Tab title="Native Perplexity API (pplx-)">
|
|
51
|
+
When your key starts with `pplx-`, Nodmix uses the native Perplexity Search
|
|
52
|
+
API. This transport returns structured results and supports domain, language,
|
|
53
|
+
and date filters (see filtering options below).
|
|
54
|
+
</Tab>
|
|
55
|
+
<Tab title="OpenRouter / Sonar (sk-or-)">
|
|
56
|
+
When your key starts with `sk-or-`, Nodmix routes through OpenRouter using
|
|
57
|
+
the Perplexity Sonar model. This transport returns AI-synthesized answers with
|
|
58
|
+
citations.
|
|
59
|
+
</Tab>
|
|
60
|
+
</Tabs>
|
|
61
|
+
|
|
62
|
+
| Key prefix | Transport | Features |
|
|
63
|
+
| ---------- | ---------------------------- | ------------------------------------------------ |
|
|
64
|
+
| `pplx-` | Native Perplexity Search API | Structured results, domain/language/date filters |
|
|
65
|
+
| `sk-or-` | OpenRouter (Sonar) | AI-synthesized answers with citations |
|
|
66
|
+
|
|
67
|
+
## Native API filtering
|
|
68
|
+
|
|
69
|
+
<Note>
|
|
70
|
+
Filtering options are only available when using the native Perplexity API
|
|
71
|
+
(`pplx-` key). OpenRouter/Sonar searches do not support these parameters.
|
|
72
|
+
</Note>
|
|
73
|
+
|
|
74
|
+
When using the native Perplexity API, searches support the following filters:
|
|
75
|
+
|
|
76
|
+
| Filter | Description | Example |
|
|
77
|
+
| -------------- | -------------------------------------- | ----------------------------------- |
|
|
78
|
+
| Country | 2-letter country code | `us`, `de`, `jp` |
|
|
79
|
+
| Language | ISO 639-1 language code | `en`, `fr`, `zh` |
|
|
80
|
+
| Date range | Recency window | `day`, `week`, `month`, `year` |
|
|
81
|
+
| Domain filters | Allowlist or denylist (max 20 domains) | `example.com` |
|
|
82
|
+
| Content budget | Token limits per response / per page | `max_tokens`, `max_tokens_per_page` |
|
|
83
|
+
|
|
84
|
+
## Advanced configuration
|
|
85
|
+
|
|
86
|
+
<AccordionGroup>
|
|
87
|
+
<Accordion title="Environment variable for daemon processes">
|
|
88
|
+
If the Nodmix Gateway runs as a daemon (launchd/systemd), make sure
|
|
89
|
+
`PERPLEXITY_API_KEY` is available to that process.
|
|
90
|
+
|
|
91
|
+
<Warning>
|
|
92
|
+
A key exported only in an interactive shell will not be visible to a
|
|
93
|
+
launchd/systemd daemon unless that environment is explicitly imported. Set
|
|
94
|
+
the key in `~/.nodmix/.env` or via `env.shellEnv` to ensure the gateway
|
|
95
|
+
process can read it.
|
|
96
|
+
</Warning>
|
|
97
|
+
|
|
98
|
+
</Accordion>
|
|
99
|
+
|
|
100
|
+
<Accordion title="OpenRouter proxy setup">
|
|
101
|
+
If you prefer to route Perplexity searches through OpenRouter, set an
|
|
102
|
+
`OPENROUTER_API_KEY` (prefix `sk-or-`) instead of a native Perplexity key.
|
|
103
|
+
Nodmix will detect the prefix and switch to the Sonar transport
|
|
104
|
+
automatically.
|
|
105
|
+
|
|
106
|
+
<Tip>
|
|
107
|
+
The OpenRouter transport is useful if you already have an OpenRouter account
|
|
108
|
+
and want consolidated billing across multiple providers.
|
|
109
|
+
</Tip>
|
|
110
|
+
|
|
111
|
+
</Accordion>
|
|
112
|
+
</AccordionGroup>
|
|
113
|
+
|
|
114
|
+
## Related
|
|
115
|
+
|
|
116
|
+
<CardGroup cols={2}>
|
|
117
|
+
<Card title="Perplexity search tool" href="/tools/perplexity-search" icon="magnifying-glass">
|
|
118
|
+
How the agent invokes Perplexity searches and interprets results.
|
|
119
|
+
</Card>
|
|
120
|
+
<Card title="Configuration reference" href="/gateway/configuration-reference" icon="gear">
|
|
121
|
+
Full configuration reference including plugin entries.
|
|
122
|
+
</Card>
|
|
123
|
+
</CardGroup>
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Use Qianfan's unified API to access many models in Nodmix"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want a single API key for many LLMs
|
|
5
|
+
- You need Baidu Qianfan setup guidance
|
|
6
|
+
title: "Qianfan"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Qianfan is Baidu's MaaS platform, providing a **unified API** that routes requests to many models behind a single
|
|
10
|
+
endpoint and API key. It is OpenAI-compatible, so most OpenAI SDKs work by switching the base URL.
|
|
11
|
+
|
|
12
|
+
| Property | Value |
|
|
13
|
+
| -------- | --------------------------------- |
|
|
14
|
+
| Provider | `qianfan` |
|
|
15
|
+
| Auth | `QIANFAN_API_KEY` |
|
|
16
|
+
| API | OpenAI-compatible |
|
|
17
|
+
| Base URL | `https://qianfan.baidubce.com/v2` |
|
|
18
|
+
|
|
19
|
+
## Getting started
|
|
20
|
+
|
|
21
|
+
<Steps>
|
|
22
|
+
<Step title="Create a Baidu Cloud account">
|
|
23
|
+
Sign up or log in at the [Qianfan Console](https://console.bce.baidu.com/qianfan/ais/console/apiKey) and ensure you have Qianfan API access enabled.
|
|
24
|
+
</Step>
|
|
25
|
+
<Step title="Generate an API key">
|
|
26
|
+
Create a new application or select an existing one, then generate an API key. The key format is `bce-v3/ALTAK-...`.
|
|
27
|
+
</Step>
|
|
28
|
+
<Step title="Run onboarding">
|
|
29
|
+
```bash
|
|
30
|
+
nodmix onboard --auth-choice qianfan-api-key
|
|
31
|
+
```
|
|
32
|
+
</Step>
|
|
33
|
+
<Step title="Verify the model is available">
|
|
34
|
+
```bash
|
|
35
|
+
nodmix models list --provider qianfan
|
|
36
|
+
```
|
|
37
|
+
</Step>
|
|
38
|
+
</Steps>
|
|
39
|
+
|
|
40
|
+
## Built-in catalog
|
|
41
|
+
|
|
42
|
+
| Model ref | Input | Context | Max output | Reasoning | Notes |
|
|
43
|
+
| ------------------------------------ | ----------- | ------- | ---------- | --------- | ------------- |
|
|
44
|
+
| `qianfan/deepseek-v3.2` | text | 98,304 | 32,768 | Yes | Default model |
|
|
45
|
+
| `qianfan/ernie-5.0-thinking-preview` | text, image | 119,000 | 64,000 | Yes | Multimodal |
|
|
46
|
+
|
|
47
|
+
<Tip>
|
|
48
|
+
The default bundled model ref is `qianfan/deepseek-v3.2`. You only need to override `models.providers.qianfan` when you need a custom base URL or model metadata.
|
|
49
|
+
</Tip>
|
|
50
|
+
|
|
51
|
+
## Config example
|
|
52
|
+
|
|
53
|
+
```json5
|
|
54
|
+
{
|
|
55
|
+
env: { QIANFAN_API_KEY: "bce-v3/ALTAK-..." },
|
|
56
|
+
agents: {
|
|
57
|
+
defaults: {
|
|
58
|
+
model: { primary: "qianfan/deepseek-v3.2" },
|
|
59
|
+
models: {
|
|
60
|
+
"qianfan/deepseek-v3.2": { alias: "QIANFAN" },
|
|
61
|
+
},
|
|
62
|
+
},
|
|
63
|
+
},
|
|
64
|
+
models: {
|
|
65
|
+
providers: {
|
|
66
|
+
qianfan: {
|
|
67
|
+
baseUrl: "https://qianfan.baidubce.com/v2",
|
|
68
|
+
api: "openai-completions",
|
|
69
|
+
models: [
|
|
70
|
+
{
|
|
71
|
+
id: "deepseek-v3.2",
|
|
72
|
+
name: "DEEPSEEK V3.2",
|
|
73
|
+
reasoning: true,
|
|
74
|
+
input: ["text"],
|
|
75
|
+
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
|
76
|
+
contextWindow: 98304,
|
|
77
|
+
maxTokens: 32768,
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
id: "ernie-5.0-thinking-preview",
|
|
81
|
+
name: "ERNIE-5.0-Thinking-Preview",
|
|
82
|
+
reasoning: true,
|
|
83
|
+
input: ["text", "image"],
|
|
84
|
+
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
|
85
|
+
contextWindow: 119000,
|
|
86
|
+
maxTokens: 64000,
|
|
87
|
+
},
|
|
88
|
+
],
|
|
89
|
+
},
|
|
90
|
+
},
|
|
91
|
+
},
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
<AccordionGroup>
|
|
96
|
+
<Accordion title="Transport and compatibility">
|
|
97
|
+
Qianfan runs through the OpenAI-compatible transport path, not native OpenAI request shaping. This means standard OpenAI SDK features work, but provider-specific parameters may not be forwarded.
|
|
98
|
+
</Accordion>
|
|
99
|
+
|
|
100
|
+
<Accordion title="Catalog and overrides">
|
|
101
|
+
The bundled catalog currently includes `deepseek-v3.2` and `ernie-5.0-thinking-preview`. Add or override `models.providers.qianfan` only when you need a custom base URL or model metadata.
|
|
102
|
+
|
|
103
|
+
<Note>
|
|
104
|
+
Model refs use the `qianfan/` prefix (for example `qianfan/deepseek-v3.2`).
|
|
105
|
+
</Note>
|
|
106
|
+
|
|
107
|
+
</Accordion>
|
|
108
|
+
|
|
109
|
+
<Accordion title="Troubleshooting">
|
|
110
|
+
- Ensure your API key starts with `bce-v3/ALTAK-` and has Qianfan API access enabled in the Baidu Cloud console.
|
|
111
|
+
- If models are not listed, confirm your account has the Qianfan service activated.
|
|
112
|
+
- The default base URL is `https://qianfan.baidubce.com/v2`. Only change it if you use a custom endpoint or proxy.
|
|
113
|
+
|
|
114
|
+
</Accordion>
|
|
115
|
+
</AccordionGroup>
|
|
116
|
+
|
|
117
|
+
## Related
|
|
118
|
+
|
|
119
|
+
<CardGroup cols={2}>
|
|
120
|
+
<Card title="Model selection" href="/concepts/model-providers" icon="layers">
|
|
121
|
+
Choosing providers, model refs, and failover behavior.
|
|
122
|
+
</Card>
|
|
123
|
+
<Card title="Configuration reference" href="/gateway/configuration-reference" icon="gear">
|
|
124
|
+
Full Nodmix configuration reference.
|
|
125
|
+
</Card>
|
|
126
|
+
<Card title="Agent setup" href="/concepts/agent" icon="robot">
|
|
127
|
+
Configuring agent defaults and model assignments.
|
|
128
|
+
</Card>
|
|
129
|
+
<Card title="Qianfan API docs" href="https://cloud.baidu.com/doc/qianfan-api/s/3m7of64lb" icon="arrow-up-right-from-square">
|
|
130
|
+
Official Qianfan API documentation.
|
|
131
|
+
</Card>
|
|
132
|
+
</CardGroup>
|
|
@@ -0,0 +1,332 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Use Qwen Cloud via Nodmix's bundled qwen provider"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to use Qwen with Nodmix
|
|
5
|
+
- You previously used Qwen OAuth
|
|
6
|
+
title: "Qwen"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
<Warning>
|
|
10
|
+
|
|
11
|
+
**Qwen OAuth has been removed.** The free-tier OAuth integration
|
|
12
|
+
(`qwen-portal`) that used `portal.qwen.ai` endpoints is no longer available.
|
|
13
|
+
See [Issue #49557](https://github.com/nodmix/nodmix/issues/49557) for
|
|
14
|
+
background.
|
|
15
|
+
|
|
16
|
+
</Warning>
|
|
17
|
+
|
|
18
|
+
Nodmix now treats Qwen as a first-class bundled provider with canonical id
|
|
19
|
+
`qwen`. The bundled provider targets the Qwen Cloud / Alibaba DashScope and
|
|
20
|
+
Coding Plan endpoints and keeps legacy `modelstudio` ids working as a
|
|
21
|
+
compatibility alias.
|
|
22
|
+
|
|
23
|
+
- Provider: `qwen`
|
|
24
|
+
- Preferred env var: `QWEN_API_KEY`
|
|
25
|
+
- Also accepted for compatibility: `MODELSTUDIO_API_KEY`, `DASHSCOPE_API_KEY`
|
|
26
|
+
- API style: OpenAI-compatible
|
|
27
|
+
|
|
28
|
+
<Tip>
|
|
29
|
+
If you want `qwen3.6-plus`, prefer the **Standard (pay-as-you-go)** endpoint.
|
|
30
|
+
Coding Plan support can lag behind the public catalog.
|
|
31
|
+
</Tip>
|
|
32
|
+
|
|
33
|
+
## Getting started
|
|
34
|
+
|
|
35
|
+
Choose your plan type and follow the setup steps.
|
|
36
|
+
|
|
37
|
+
<Tabs>
|
|
38
|
+
<Tab title="Coding Plan (subscription)">
|
|
39
|
+
**Best for:** subscription-based access through the Qwen Coding Plan.
|
|
40
|
+
|
|
41
|
+
<Steps>
|
|
42
|
+
<Step title="Get your API key">
|
|
43
|
+
Create or copy an API key from [home.qwencloud.com/api-keys](https://home.qwencloud.com/api-keys).
|
|
44
|
+
</Step>
|
|
45
|
+
<Step title="Run onboarding">
|
|
46
|
+
For the **Global** endpoint:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
nodmix onboard --auth-choice qwen-api-key
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
For the **China** endpoint:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
nodmix onboard --auth-choice qwen-api-key-cn
|
|
56
|
+
```
|
|
57
|
+
</Step>
|
|
58
|
+
<Step title="Set a default model">
|
|
59
|
+
```json5
|
|
60
|
+
{
|
|
61
|
+
agents: {
|
|
62
|
+
defaults: {
|
|
63
|
+
model: { primary: "qwen/qwen3.5-plus" },
|
|
64
|
+
},
|
|
65
|
+
},
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
</Step>
|
|
69
|
+
<Step title="Verify the model is available">
|
|
70
|
+
```bash
|
|
71
|
+
nodmix models list --provider qwen
|
|
72
|
+
```
|
|
73
|
+
</Step>
|
|
74
|
+
</Steps>
|
|
75
|
+
|
|
76
|
+
<Note>
|
|
77
|
+
Legacy `modelstudio-*` auth-choice ids and `modelstudio/...` model refs still
|
|
78
|
+
work as compatibility aliases, but new setup flows should prefer the canonical
|
|
79
|
+
`qwen-*` auth-choice ids and `qwen/...` model refs. If you define an exact
|
|
80
|
+
custom `models.providers.modelstudio` entry with another `api` value, that
|
|
81
|
+
custom provider owns `modelstudio/...` refs instead of the Qwen compatibility
|
|
82
|
+
alias.
|
|
83
|
+
</Note>
|
|
84
|
+
|
|
85
|
+
</Tab>
|
|
86
|
+
|
|
87
|
+
<Tab title="Standard (pay-as-you-go)">
|
|
88
|
+
**Best for:** pay-as-you-go access through the Standard Model Studio endpoint, including models like `qwen3.6-plus` that may not be available on the Coding Plan.
|
|
89
|
+
|
|
90
|
+
<Steps>
|
|
91
|
+
<Step title="Get your API key">
|
|
92
|
+
Create or copy an API key from [home.qwencloud.com/api-keys](https://home.qwencloud.com/api-keys).
|
|
93
|
+
</Step>
|
|
94
|
+
<Step title="Run onboarding">
|
|
95
|
+
For the **Global** endpoint:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
nodmix onboard --auth-choice qwen-standard-api-key
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
For the **China** endpoint:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
nodmix onboard --auth-choice qwen-standard-api-key-cn
|
|
105
|
+
```
|
|
106
|
+
</Step>
|
|
107
|
+
<Step title="Set a default model">
|
|
108
|
+
```json5
|
|
109
|
+
{
|
|
110
|
+
agents: {
|
|
111
|
+
defaults: {
|
|
112
|
+
model: { primary: "qwen/qwen3.5-plus" },
|
|
113
|
+
},
|
|
114
|
+
},
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
</Step>
|
|
118
|
+
<Step title="Verify the model is available">
|
|
119
|
+
```bash
|
|
120
|
+
nodmix models list --provider qwen
|
|
121
|
+
```
|
|
122
|
+
</Step>
|
|
123
|
+
</Steps>
|
|
124
|
+
|
|
125
|
+
<Note>
|
|
126
|
+
Legacy `modelstudio-*` auth-choice ids and `modelstudio/...` model refs still
|
|
127
|
+
work as compatibility aliases, but new setup flows should prefer the canonical
|
|
128
|
+
`qwen-*` auth-choice ids and `qwen/...` model refs. If you define an exact
|
|
129
|
+
custom `models.providers.modelstudio` entry with another `api` value, that
|
|
130
|
+
custom provider owns `modelstudio/...` refs instead of the Qwen compatibility
|
|
131
|
+
alias.
|
|
132
|
+
</Note>
|
|
133
|
+
|
|
134
|
+
</Tab>
|
|
135
|
+
</Tabs>
|
|
136
|
+
|
|
137
|
+
## Plan types and endpoints
|
|
138
|
+
|
|
139
|
+
| Plan | Region | Auth choice | Endpoint |
|
|
140
|
+
| -------------------------- | ------ | -------------------------- | ------------------------------------------------ |
|
|
141
|
+
| Standard (pay-as-you-go) | China | `qwen-standard-api-key-cn` | `dashscope.aliyuncs.com/compatible-mode/v1` |
|
|
142
|
+
| Standard (pay-as-you-go) | Global | `qwen-standard-api-key` | `dashscope-intl.aliyuncs.com/compatible-mode/v1` |
|
|
143
|
+
| Coding Plan (subscription) | China | `qwen-api-key-cn` | `coding.dashscope.aliyuncs.com/v1` |
|
|
144
|
+
| Coding Plan (subscription) | Global | `qwen-api-key` | `coding-intl.dashscope.aliyuncs.com/v1` |
|
|
145
|
+
|
|
146
|
+
The provider auto-selects the endpoint based on your auth choice. Canonical
|
|
147
|
+
choices use the `qwen-*` family; `modelstudio-*` remains compatibility-only.
|
|
148
|
+
You can override with a custom `baseUrl` in config.
|
|
149
|
+
|
|
150
|
+
<Tip>
|
|
151
|
+
**Manage keys:** [home.qwencloud.com/api-keys](https://home.qwencloud.com/api-keys) |
|
|
152
|
+
**Docs:** [docs.qwencloud.com](https://docs.qwencloud.com/developer-guides/getting-started/introduction)
|
|
153
|
+
</Tip>
|
|
154
|
+
|
|
155
|
+
## Built-in catalog
|
|
156
|
+
|
|
157
|
+
Nodmix currently ships this bundled Qwen catalog. The configured catalog is
|
|
158
|
+
endpoint-aware: Coding Plan configs omit models that are only known to work on
|
|
159
|
+
the Standard endpoint.
|
|
160
|
+
|
|
161
|
+
| Model ref | Input | Context | Notes |
|
|
162
|
+
| --------------------------- | ----------- | --------- | -------------------------------------------------- |
|
|
163
|
+
| `qwen/qwen3.5-plus` | text, image | 1,000,000 | Default model |
|
|
164
|
+
| `qwen/qwen3.6-plus` | text, image | 1,000,000 | Prefer Standard endpoints when you need this model |
|
|
165
|
+
| `qwen/qwen3-max-2026-01-23` | text | 262,144 | Qwen Max line |
|
|
166
|
+
| `qwen/qwen3-coder-next` | text | 262,144 | Coding |
|
|
167
|
+
| `qwen/qwen3-coder-plus` | text | 1,000,000 | Coding |
|
|
168
|
+
| `qwen/MiniMax-M2.5` | text | 1,000,000 | Reasoning enabled |
|
|
169
|
+
| `qwen/glm-5` | text | 202,752 | GLM |
|
|
170
|
+
| `qwen/glm-4.7` | text | 202,752 | GLM |
|
|
171
|
+
| `qwen/kimi-k2.5` | text, image | 262,144 | Moonshot AI via Alibaba |
|
|
172
|
+
|
|
173
|
+
<Note>
|
|
174
|
+
Availability can still vary by endpoint and billing plan even when a model is
|
|
175
|
+
present in the bundled catalog.
|
|
176
|
+
</Note>
|
|
177
|
+
|
|
178
|
+
## Thinking Controls
|
|
179
|
+
|
|
180
|
+
For reasoning-enabled Qwen Cloud models, the bundled provider maps Nodmix
|
|
181
|
+
thinking levels to DashScope's top-level `enable_thinking` request flag. Disabled
|
|
182
|
+
thinking sends `enable_thinking: false`; other thinking levels send
|
|
183
|
+
`enable_thinking: true`.
|
|
184
|
+
|
|
185
|
+
## Multimodal add-ons
|
|
186
|
+
|
|
187
|
+
The `qwen` plugin also exposes multimodal capabilities on the **Standard**
|
|
188
|
+
DashScope endpoints (not the Coding Plan endpoints):
|
|
189
|
+
|
|
190
|
+
- **Video understanding** via `qwen-vl-max-latest`
|
|
191
|
+
- **Wan video generation** via `wan2.6-t2v` (default), `wan2.6-i2v`, `wan2.6-r2v`, `wan2.6-r2v-flash`, `wan2.7-r2v`
|
|
192
|
+
|
|
193
|
+
To use Qwen as the default video provider:
|
|
194
|
+
|
|
195
|
+
```json5
|
|
196
|
+
{
|
|
197
|
+
agents: {
|
|
198
|
+
defaults: {
|
|
199
|
+
videoGenerationModel: { primary: "qwen/wan2.6-t2v" },
|
|
200
|
+
},
|
|
201
|
+
},
|
|
202
|
+
}
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
<Note>
|
|
206
|
+
See [Video Generation](/tools/video-generation) for shared tool parameters, provider selection, and failover behavior.
|
|
207
|
+
</Note>
|
|
208
|
+
|
|
209
|
+
## Advanced configuration
|
|
210
|
+
|
|
211
|
+
<AccordionGroup>
|
|
212
|
+
<Accordion title="Image and video understanding">
|
|
213
|
+
The bundled Qwen plugin registers media understanding for images and video
|
|
214
|
+
on the **Standard** DashScope endpoints (not the Coding Plan endpoints).
|
|
215
|
+
|
|
216
|
+
| Property | Value |
|
|
217
|
+
| ------------- | --------------------- |
|
|
218
|
+
| Model | `qwen-vl-max-latest` |
|
|
219
|
+
| Supported input | Images, video |
|
|
220
|
+
|
|
221
|
+
Media understanding is auto-resolved from the configured Qwen auth — no
|
|
222
|
+
additional config is needed. Ensure you are using a Standard (pay-as-you-go)
|
|
223
|
+
endpoint for media understanding support.
|
|
224
|
+
|
|
225
|
+
</Accordion>
|
|
226
|
+
|
|
227
|
+
<Accordion title="Qwen 3.6 Plus availability">
|
|
228
|
+
`qwen3.6-plus` is available on the Standard (pay-as-you-go) Model Studio
|
|
229
|
+
endpoints:
|
|
230
|
+
|
|
231
|
+
- China: `dashscope.aliyuncs.com/compatible-mode/v1`
|
|
232
|
+
- Global: `dashscope-intl.aliyuncs.com/compatible-mode/v1`
|
|
233
|
+
|
|
234
|
+
If the Coding Plan endpoints return an "unsupported model" error for
|
|
235
|
+
`qwen3.6-plus`, switch to Standard (pay-as-you-go) instead of the Coding Plan
|
|
236
|
+
endpoint/key pair.
|
|
237
|
+
|
|
238
|
+
Nodmix's bundled Qwen catalog does not advertise `qwen3.6-plus` on Coding
|
|
239
|
+
Plan endpoints, but explicitly configured `qwen/qwen3.6-plus` entries under
|
|
240
|
+
`models.providers.qwen.models` are honored on Coding Plan baseUrls so you
|
|
241
|
+
can opt that model in if Aliyun enables it on your subscription. The
|
|
242
|
+
upstream API still decides whether the call succeeds.
|
|
243
|
+
|
|
244
|
+
</Accordion>
|
|
245
|
+
|
|
246
|
+
<Accordion title="Capability plan">
|
|
247
|
+
The `qwen` plugin is being positioned as the vendor home for the full Qwen
|
|
248
|
+
Cloud surface, not just coding/text models.
|
|
249
|
+
|
|
250
|
+
- **Text/chat models:** bundled now
|
|
251
|
+
- **Tool calling, structured output, thinking:** inherited from the OpenAI-compatible transport
|
|
252
|
+
- **Image generation:** planned at the provider-plugin layer
|
|
253
|
+
- **Image/video understanding:** bundled now on the Standard endpoint
|
|
254
|
+
- **Speech/audio:** planned at the provider-plugin layer
|
|
255
|
+
- **Memory embeddings/reranking:** planned through the embedding adapter surface
|
|
256
|
+
- **Video generation:** bundled now through the shared video-generation capability
|
|
257
|
+
|
|
258
|
+
</Accordion>
|
|
259
|
+
|
|
260
|
+
<Accordion title="Video generation details">
|
|
261
|
+
For video generation, Nodmix maps the configured Qwen region to the matching
|
|
262
|
+
DashScope AIGC host before submitting the job:
|
|
263
|
+
|
|
264
|
+
- Global/Intl: `https://dashscope-intl.aliyuncs.com`
|
|
265
|
+
- China: `https://dashscope.aliyuncs.com`
|
|
266
|
+
|
|
267
|
+
That means a normal `models.providers.qwen.baseUrl` pointing at either the
|
|
268
|
+
Coding Plan or Standard Qwen hosts still keeps video generation on the correct
|
|
269
|
+
regional DashScope video endpoint.
|
|
270
|
+
|
|
271
|
+
Current bundled Qwen video-generation limits:
|
|
272
|
+
|
|
273
|
+
- Up to **1** output video per request
|
|
274
|
+
- Up to **1** input image
|
|
275
|
+
- Up to **4** input videos
|
|
276
|
+
- Up to **10 seconds** duration
|
|
277
|
+
- Supports `size`, `aspectRatio`, `resolution`, `audio`, and `watermark`
|
|
278
|
+
- Reference image/video mode currently requires **remote http(s) URLs**. Local
|
|
279
|
+
file paths are rejected up front because the DashScope video endpoint does not
|
|
280
|
+
accept uploaded local buffers for those references.
|
|
281
|
+
|
|
282
|
+
</Accordion>
|
|
283
|
+
|
|
284
|
+
<Accordion title="Streaming usage compatibility">
|
|
285
|
+
Native Model Studio endpoints advertise streaming usage compatibility on the
|
|
286
|
+
shared `openai-completions` transport. Nodmix keys that off endpoint
|
|
287
|
+
capabilities now, so DashScope-compatible custom provider ids targeting the
|
|
288
|
+
same native hosts inherit the same streaming-usage behavior instead of
|
|
289
|
+
requiring the built-in `qwen` provider id specifically.
|
|
290
|
+
|
|
291
|
+
Native-streaming usage compatibility applies to both the Coding Plan hosts and
|
|
292
|
+
the Standard DashScope-compatible hosts:
|
|
293
|
+
|
|
294
|
+
- `https://coding.dashscope.aliyuncs.com/v1`
|
|
295
|
+
- `https://coding-intl.dashscope.aliyuncs.com/v1`
|
|
296
|
+
- `https://dashscope.aliyuncs.com/compatible-mode/v1`
|
|
297
|
+
- `https://dashscope-intl.aliyuncs.com/compatible-mode/v1`
|
|
298
|
+
|
|
299
|
+
</Accordion>
|
|
300
|
+
|
|
301
|
+
<Accordion title="Multimodal endpoint regions">
|
|
302
|
+
Multimodal surfaces (video understanding and Wan video generation) use the
|
|
303
|
+
**Standard** DashScope endpoints, not the Coding Plan endpoints:
|
|
304
|
+
|
|
305
|
+
- Global/Intl Standard base URL: `https://dashscope-intl.aliyuncs.com/compatible-mode/v1`
|
|
306
|
+
- China Standard base URL: `https://dashscope.aliyuncs.com/compatible-mode/v1`
|
|
307
|
+
|
|
308
|
+
</Accordion>
|
|
309
|
+
|
|
310
|
+
<Accordion title="Environment and daemon setup">
|
|
311
|
+
If the Gateway runs as a daemon (launchd/systemd), make sure `QWEN_API_KEY` is
|
|
312
|
+
available to that process (for example, in `~/.nodmix/.env` or via
|
|
313
|
+
`env.shellEnv`).
|
|
314
|
+
</Accordion>
|
|
315
|
+
</AccordionGroup>
|
|
316
|
+
|
|
317
|
+
## Related
|
|
318
|
+
|
|
319
|
+
<CardGroup cols={2}>
|
|
320
|
+
<Card title="Model selection" href="/concepts/model-providers" icon="layers">
|
|
321
|
+
Choosing providers, model refs, and failover behavior.
|
|
322
|
+
</Card>
|
|
323
|
+
<Card title="Video generation" href="/tools/video-generation" icon="video">
|
|
324
|
+
Shared video tool parameters and provider selection.
|
|
325
|
+
</Card>
|
|
326
|
+
<Card title="Alibaba (ModelStudio)" href="/providers/alibaba" icon="cloud">
|
|
327
|
+
Legacy ModelStudio provider and migration notes.
|
|
328
|
+
</Card>
|
|
329
|
+
<Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
|
|
330
|
+
General troubleshooting and FAQ.
|
|
331
|
+
</Card>
|
|
332
|
+
</CardGroup>
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Runway video generation setup in Nodmix"
|
|
3
|
+
title: "Runway"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to use Runway video generation in Nodmix
|
|
6
|
+
- You need the Runway API key/env setup
|
|
7
|
+
- You want to make Runway the default video provider
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Nodmix ships a bundled `runway` provider for hosted video generation. The plugin is enabled by default and registers the `runway` provider against the `videoGenerationProviders` contract.
|
|
11
|
+
|
|
12
|
+
| Property | Value |
|
|
13
|
+
| --------------- | ----------------------------------------------------------------- |
|
|
14
|
+
| Provider id | `runway` |
|
|
15
|
+
| Plugin | bundled, `enabledByDefault: true` |
|
|
16
|
+
| Auth env vars | `RUNWAYML_API_SECRET` (canonical) or `RUNWAY_API_KEY` |
|
|
17
|
+
| Onboarding flag | `--auth-choice runway-api-key` |
|
|
18
|
+
| Direct CLI flag | `--runway-api-key <key>` |
|
|
19
|
+
| API | Runway task-based video generation (`GET /v1/tasks/{id}` polling) |
|
|
20
|
+
| Default model | `runway/gen4.5` |
|
|
21
|
+
|
|
22
|
+
## Getting started
|
|
23
|
+
|
|
24
|
+
<Steps>
|
|
25
|
+
<Step title="Set the API key">
|
|
26
|
+
```bash
|
|
27
|
+
nodmix onboard --auth-choice runway-api-key
|
|
28
|
+
```
|
|
29
|
+
</Step>
|
|
30
|
+
<Step title="Set Runway as the default video provider">
|
|
31
|
+
```bash
|
|
32
|
+
nodmix config set agents.defaults.videoGenerationModel.primary "runway/gen4.5"
|
|
33
|
+
```
|
|
34
|
+
</Step>
|
|
35
|
+
<Step title="Generate a video">
|
|
36
|
+
Ask the agent to generate a video. Runway will be used automatically.
|
|
37
|
+
</Step>
|
|
38
|
+
</Steps>
|
|
39
|
+
|
|
40
|
+
## Supported modes and models
|
|
41
|
+
|
|
42
|
+
The provider exposes seven Runway models split across three modes. The same model id can serve more than one mode (for example `gen4.5` works for both text-to-video and image-to-video).
|
|
43
|
+
|
|
44
|
+
| Mode | Models | Reference input |
|
|
45
|
+
| -------------- | ---------------------------------------------------------------------- | ----------------------- |
|
|
46
|
+
| Text-to-video | `gen4.5` (default), `veo3.1`, `veo3.1_fast`, `veo3` | None |
|
|
47
|
+
| Image-to-video | `gen4.5`, `gen4_turbo`, `gen3a_turbo`, `veo3.1`, `veo3.1_fast`, `veo3` | 1 local or remote image |
|
|
48
|
+
| Video-to-video | `gen4_aleph` | 1 local or remote video |
|
|
49
|
+
|
|
50
|
+
Local image and video references are supported via data URIs.
|
|
51
|
+
|
|
52
|
+
| Aspect ratios | Allowed values |
|
|
53
|
+
| --------------------- | ------------------------------------------- |
|
|
54
|
+
| Text-to-video | `16:9`, `9:16` |
|
|
55
|
+
| Image and video edits | `1:1`, `16:9`, `9:16`, `3:4`, `4:3`, `21:9` |
|
|
56
|
+
|
|
57
|
+
<Warning>
|
|
58
|
+
Video-to-video currently requires `runway/gen4_aleph`. Other Runway model ids reject video reference inputs.
|
|
59
|
+
</Warning>
|
|
60
|
+
|
|
61
|
+
<Note>
|
|
62
|
+
Picking a Runway model id from the wrong column produces an explicit error before the API request leaves Nodmix. The provider validates `model` against the mode's allowlist (`TEXT_ONLY_MODELS`, `IMAGE_MODELS`, `VIDEO_MODELS`) in `extensions/runway/video-generation-provider.ts`.
|
|
63
|
+
</Note>
|
|
64
|
+
|
|
65
|
+
## Configuration
|
|
66
|
+
|
|
67
|
+
```json5
|
|
68
|
+
{
|
|
69
|
+
agents: {
|
|
70
|
+
defaults: {
|
|
71
|
+
videoGenerationModel: {
|
|
72
|
+
primary: "runway/gen4.5",
|
|
73
|
+
},
|
|
74
|
+
},
|
|
75
|
+
},
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Advanced configuration
|
|
80
|
+
|
|
81
|
+
<AccordionGroup>
|
|
82
|
+
<Accordion title="Environment variable aliases">
|
|
83
|
+
Nodmix recognizes both `RUNWAYML_API_SECRET` (canonical) and `RUNWAY_API_KEY`.
|
|
84
|
+
Either variable will authenticate the Runway provider.
|
|
85
|
+
</Accordion>
|
|
86
|
+
|
|
87
|
+
<Accordion title="Task polling">
|
|
88
|
+
Runway uses a task-based API. After submitting a generation request, Nodmix
|
|
89
|
+
polls `GET /v1/tasks/{id}` until the video is ready. No additional
|
|
90
|
+
configuration is needed for the polling behavior.
|
|
91
|
+
</Accordion>
|
|
92
|
+
</AccordionGroup>
|
|
93
|
+
|
|
94
|
+
## Related
|
|
95
|
+
|
|
96
|
+
<CardGroup cols={2}>
|
|
97
|
+
<Card title="Video generation" href="/tools/video-generation" icon="video">
|
|
98
|
+
Shared tool parameters, provider selection, and async behavior.
|
|
99
|
+
</Card>
|
|
100
|
+
<Card title="Configuration reference" href="/gateway/config-agents#agent-defaults" icon="gear">
|
|
101
|
+
Agent default settings including video generation model.
|
|
102
|
+
</Card>
|
|
103
|
+
</CardGroup>
|