Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
tools.*-configuratiesleutels en aangepaste provider- / basis-URL-configuratie. Zie voor agents, kanalen en andere configuratiesleutels op topniveau de Configuratiereferentie.
Hulpmiddelen
Hulpmiddelprofielen
tools.profile stelt een basis-allowlist in vóór tools.allow/tools.deny:
Lokale onboarding zet nieuwe lokale configuraties standaard op
tools.profile: "coding" wanneer dit niet is ingesteld (bestaande expliciete profielen blijven behouden).| Profiel | Omvat |
|---|---|
minimal | alleen session_status |
coding | group:fs, group:runtime, group:web, group:sessions, group:memory, cron, image, image_generate, video_generate |
messaging | group:messaging, sessions_list, sessions_history, sessions_send, session_status |
full | Geen beperking (hetzelfde als niet ingesteld) |
Hulpmiddelgroepen
| Groep | Hulpmiddelen |
|---|---|
group:runtime | exec, process, code_execution (bash wordt geaccepteerd als alias voor exec) |
group:fs | read, write, edit, apply_patch |
group:sessions | sessions_list, sessions_history, sessions_send, sessions_spawn, sessions_yield, subagents, session_status |
group:memory | memory_search, memory_get |
group:web | web_search, x_search, web_fetch |
group:ui | browser, canvas |
group:automation | heartbeat_respond, cron, gateway |
group:messaging | message |
group:nodes | nodes |
group:agents | agents_list, update_plan |
group:media | image, image_generate, music_generate, video_generate, tts |
group:openclaw | Alle ingebouwde hulpmiddelen (exclusief provider-plugins) |
tools.allow / tools.deny
Globaal allow/deny-beleid voor hulpmiddelen (deny wint). Hoofdletterongevoelig, ondersteunt *-wildcards. Wordt ook toegepast wanneer de Docker-sandbox uit staat.
write en apply_patch zijn afzonderlijke hulpmiddel-id’s. allow: ["write"] schakelt ook apply_patch in voor compatibele modellen, maar deny: ["write"] weigert apply_patch niet. Weiger group:fs of vermeld elk muterend hulpmiddel expliciet om alle bestandsmutaties te blokkeren:
tools.byProvider
Beperk hulpmiddelen verder voor specifieke providers of modellen. Volgorde: basisprofiel → providerprofiel → allow/deny.
tools.toolsBySender
Beperkt hulpmiddelen voor een specifieke aanvrageridentiteit. Dit is defense-in-depth bovenop toegangscontrole voor kanalen; sender-waarden moeten uit de kanaaladapter komen, niet uit berichttekst.
channel:<channelId>:<senderId>, id:<senderId>, e164:<phone>, username:<handle>, name:<displayName>, of "*". Kanaal-id’s zijn canonieke OpenClaw-id’s; aliassen zoals teams normaliseren naar msteams. Verouderde sleutels zonder voorvoegsel worden alleen als id: geaccepteerd. De matchvolgorde is channel+id, id, e164, username, name en daarna wildcard.
Per-agent agents.list[].tools.toolsBySender overschrijft de globale sender-match wanneer die overeenkomt, zelfs met een leeg {}-beleid.
tools.elevated
Regelt verhoogde exec-toegang buiten de sandbox:
- Per-agent override (
agents.list[].tools.elevated) kan alleen verder beperken. /elevated on|off|ask|fullslaat de status per sessie op; inline directives gelden voor één bericht.- Verhoogde
execomzeilt sandboxing en gebruikt het geconfigureerde escape-pad (standaardgateway, ofnodewanneer het exec-doelnodeis).
tools.exec
tools.loopDetection
Tool-loop-veiligheidscontroles zijn standaard uitgeschakeld. Stel enabled: true in om detectie te activeren. Instellingen kunnen globaal worden gedefinieerd in tools.loopDetection en per agent worden overschreven via agents.list[].tools.loopDetection.
Maximaal bewaarde tool-call-geschiedenis voor loopanalyse.
Drempel voor herhalende patronen zonder voortgang voor waarschuwingen.
Hogere herhalingsdrempel voor het blokkeren van kritieke loops.
Harde stopdrempel voor elke run zonder voortgang.
Waarschuw bij herhaalde aanroepen met dezelfde tool/dezelfde argumenten.
Waarschuw/blokkeer bij bekende poll-tools (
process.poll, command_status, enz.).Waarschuw/blokkeer bij afwisselende paarpatronen zonder voortgang.
tools.web
tools.media
Configureert begrip van inkomende media (afbeelding/audio/video):
Media model entry fields
Media model entry fields
Provider-vermelding (
type: "provider" of weggelaten):provider: API-provider-id (openai,anthropic,google/gemini,groq, enz.)model: overschrijving van model-idprofile/preferredProfile: profielselectie inauth-profiles.json
type: "cli"):command: uitvoerbaar bestand om uit te voerenargs: getemplate argumenten (ondersteunt{{MediaPath}},{{Prompt}},{{MaxChars}}, enz.;openclaw doctor --fixmigreert verouderde{input}-placeholders naar{{MediaPath}})
capabilities: optionele lijst (image,audio,video). Standaarden:openai/anthropic/minimax→ afbeelding,google→ afbeelding+audio+video,groq→ audio.prompt,maxChars,maxBytes,timeoutSeconds,language: overschrijvingen per vermelding.tools.media.image.timeoutSecondsen overeenkomendetimeoutSeconds-vermeldingen voor afbeeldingsmodellen zijn ook van toepassing wanneer de agent de explicieteimage-tool aanroept.- Mislukkingen vallen terug op de volgende vermelding.
auth-profiles.json → env-vars → models.providers.*.apiKey.Velden voor asynchrone voltooiing:asyncCompletion.directSend: verouderde compatibiliteitsvlag. Voltooide asynchrone mediataken blijven via de sessie van de aanvrager bemiddeld, zodat de agent het resultaat ontvangt, beslist hoe de gebruiker wordt geïnformeerd en de berichtentool gebruikt wanneer bezorging via de bron dat vereist.
tools.agentToAgent
tools.sessions
Bepaalt welke sessies kunnen worden gericht door de sessietools (sessions_list, sessions_history, sessions_send).
Standaard: tree (huidige sessie + sessies die daardoor zijn gespawnd, zoals subagents).
Visibility scopes
Visibility scopes
self: alleen de huidige sessiesleutel.tree: huidige sessie + sessies die door de huidige sessie zijn gespawnd (subagents).agent: elke sessie die bij de huidige agent-id hoort (kan andere gebruikers omvatten als je per-afzender-sessies onder dezelfde agent-id uitvoert).all: elke sessie. Richten op andere agents vereist nog steedstools.agentToAgent.- Sandbox-beperking: wanneer de huidige sessie in een sandbox draait en
agents.defaults.sandbox.sessionToolsVisibility="spawned", wordt zichtbaarheid geforceerd naartree, zelfs alstools.sessions.visibility="all".
tools.sessions_spawn
Bepaalt inline-bijlageondersteuning voor sessions_spawn.
Attachment notes
Attachment notes
- Bijlagen worden alleen ondersteund voor
runtime: "subagent". ACP-runtime weigert ze. - Bestanden worden in de child-werkruimte gematerialiseerd op
.openclaw/attachments/<uuid>/met een.manifest.json. - Bijlage-inhoud wordt automatisch geredigeerd uit transcriptpersistentie.
- Base64-invoer wordt gevalideerd met strikte controles op alfabet/opvulling en een groottebeveiliging vóór decodering.
- Bestandsmachtigingen zijn
0700voor mappen en0600voor bestanden. - Opschoning volgt het
cleanup-beleid:deleteverwijdert bijlagen altijd;keepbehoudt ze alleen wanneerretainOnSessionKeep: true.
tools.experimental
Experimentele ingebouwde toolvlaggen. Standaard uit, tenzij een strict-agentic GPT-5-regel voor automatisch inschakelen van toepassing is.
planTool: schakelt de gestructureerdeupdate_plan-tool in voor het bijhouden van niet-triviaal meerstapswerk.- Standaard:
false, tenzijagents.defaults.embeddedPi.executionContract(of een override per agent) is ingesteld op"strict-agentic"voor een OpenAI- of OpenAI Codex-run uit de GPT-5-familie. Stel in optrueom de tool buiten dat bereik geforceerd in te schakelen, of opfalseom deze zelfs voor strict-agentic GPT-5-runs uitgeschakeld te houden. - Wanneer ingeschakeld, voegt de systeemprompt ook gebruiksrichtlijnen toe, zodat het model de tool alleen voor substantieel werk gebruikt en maximaal één stap op
in_progresshoudt.
agents.defaults.subagents
model: standaardmodel voor gestarte subagenten. Indien weggelaten, erven subagenten het model van de aanroeper.allowAgents: standaardtoelatingslijst van doelagent-id’s voorsessions_spawnwanneer de aanvragende agent geen eigensubagents.allowAgentsinstelt (["*"]= elke; standaard: alleen dezelfde agent).runTimeoutSeconds: standaardtime-out (seconden) voorsessions_spawnwanneer de toolaanroeprunTimeoutSecondsweglaat.0betekent geen time-out.announceTimeoutMs: time-out per aanroep (milliseconden) voor pogingen tot aflevering van Gateway-agent-aankondigingen. Standaard:120000. Tijdelijke herhalingspogingen kunnen ervoor zorgen dat de totale wachttijd voor aankondigingen langer is dan één geconfigureerde time-out.- Toolbeleid per subagent:
tools.subagents.tools.allow/tools.subagents.tools.deny.
Aangepaste providers en basis-URL’s
OpenClaw gebruikt de ingebouwde modelcatalogus. Voeg aangepaste providers toe viamodels.providers in config of ~/.openclaw/agents/<agentId>/agent/models.json.
Authenticatie en samenvoegingsvoorrang
Authenticatie en samenvoegingsvoorrang
- Gebruik
authHeader: true+headersvoor aangepaste authenticatiebehoeften. - Overschrijf de root van de agentconfig met
OPENCLAW_AGENT_DIR(ofPI_CODING_AGENT_DIR, een alias voor een verouderde omgevingsvariabele). - Samenvoegingsvoorrang voor overeenkomende provider-ID’s:
- Niet-lege
baseUrl-waarden in agent-models.jsonwinnen. - Niet-lege
apiKey-waarden van de agent winnen alleen wanneer die provider niet door SecretRef wordt beheerd in de huidige config-/auth-profielcontext. - Door SecretRef beheerde provider-
apiKey-waarden worden vernieuwd vanuit bronmarkeringen (ENV_VAR_NAMEvoor env-verwijzingen,secretref-managedvoor bestand-/exec-verwijzingen) in plaats van opgeloste geheimen te bewaren. - Door SecretRef beheerde provider-headerwaarden worden vernieuwd vanuit bronmarkeringen (
secretref-env:ENV_VAR_NAMEvoor env-verwijzingen,secretref-managedvoor bestand-/exec-verwijzingen). - Lege of ontbrekende agent-
apiKey/baseUrlvallen terug opmodels.providersin config. - Overeenkomende model-
contextWindow/maxTokensgebruiken de hogere waarde van expliciete config en impliciete cataloguswaarden. - Overeenkomende model-
contextTokensbehouden een expliciete runtime-limiet wanneer aanwezig; gebruik dit om de effectieve context te beperken zonder de native modelmetadata te wijzigen. - Gebruik
models.mode: "replace"wanneer je wilt dat configmodels.jsonvolledig herschrijft. - Markeringpersistentie is bronauthoritatief: markeringen worden geschreven vanuit de actieve bronconfigsnapshot (vóór oplossing), niet vanuit opgeloste runtime-geheime waarden.
- Niet-lege
Details van providervelden
Catalogus op topniveau
Catalogus op topniveau
models.mode: gedrag van de providercatalogus (mergeofreplace).models.providers: aangepaste providermap, geïndexeerd op provider-id.- Veilige bewerkingen: gebruik
openclaw config set models.providers.<id> '<json>' --strict-json --mergeofopenclaw config set models.providers.<id>.models '<json-array>' --strict-json --mergevoor additieve updates.config setweigert destructieve vervangingen tenzij je--replacemeegeeft.
- Veilige bewerkingen: gebruik
Providerverbinding en authenticatie
Providerverbinding en authenticatie
models.providers.*.api: aanvraagadapter (openai-completions,openai-responses,anthropic-messages,google-generative-ai, enz.). Gebruikopenai-completionsvoor zelfgehoste/v1/chat/completions-backends zoals MLX, vLLM, SGLang en de meeste OpenAI-compatibele lokale servers. Een aangepaste provider metbaseUrlmaar zonderapigebruikt standaardopenai-completions; stelopenai-responsesalleen in wanneer de backend/v1/responsesondersteunt.models.providers.*.apiKey: providerreferentie (bij voorkeur SecretRef/env-substitutie).models.providers.*.auth: authenticatiestrategie (api-key,token,oauth,aws-sdk).models.providers.*.contextWindow: standaard native contextvenster voor modellen onder deze provider wanneer de modelvermelding geencontextWindowinstelt.models.providers.*.contextTokens: standaard effectieve runtime-contextlimiet voor modellen onder deze provider wanneer de modelvermelding geencontextTokensinstelt.models.providers.*.maxTokens: standaardlimiet voor uitvoertokens voor modellen onder deze provider wanneer de modelvermelding geenmaxTokensinstelt.models.providers.*.timeoutSeconds: optionele HTTP-aanvraagtime-out per provider-model in seconden, inclusief verbinding, headers, body en afhandeling van afbreken van de totale aanvraag.models.providers.*.injectNumCtxForOpenAICompat: injecteer voor Ollama +openai-completionsoptions.num_ctxin aanvragen (standaard:true).models.providers.*.authHeader: forceer transport van referenties in deAuthorization-header wanneer vereist.models.providers.*.baseUrl: basis-URL van de upstream-API.models.providers.*.headers: extra statische headers voor proxy-/tenantroutering.
Overschrijvingen voor aanvraagtransport
Overschrijvingen voor aanvraagtransport
models.providers.*.request: transportoverschrijvingen voor HTTP-aanvragen aan modelproviders.request.headers: extra headers (samengevoegd met providerstandaarden). Waarden accepteren SecretRef.request.auth: overschrijving van authenticatiestrategie. Modi:"provider-default"(gebruik de ingebouwde authenticatie van de provider),"authorization-bearer"(mettoken),"header"(metheaderName,value, optioneelprefix).request.proxy: overschrijving van HTTP-proxy. Modi:"env-proxy"(gebruik de env-varsHTTP_PROXY/HTTPS_PROXY),"explicit-proxy"(meturl). Beide modi accepteren een optioneeltls-subobject.request.tls: TLS-overschrijving voor directe verbindingen. Velden:ca,cert,key,passphrase(allemaal accepteren SecretRef),serverName,insecureSkipVerify.request.allowPrivateNetwork: wanneertrue, HTTPS naarbaseUrltoestaan wanneer DNS wordt opgelost naar private, CGNAT- of vergelijkbare bereiken, via de HTTP-fetchbeveiliging van de provider (operator-opt-in voor vertrouwde zelfgehoste OpenAI-compatibele endpoints). Stream-URL’s voor modelproviders op loopback zoalslocalhost,127.0.0.1en[::1]worden automatisch toegestaan, tenzij dit expliciet opfalseis ingesteld; LAN-, tailnet- en private DNS-hosts vereisen nog steeds opt-in. WebSocket gebruikt dezelfderequestvoor headers/TLS, maar niet die fetch-SSRF-poort. Standaardfalse.
Modelcatalogusvermeldingen
Modelcatalogusvermeldingen
models.providers.*.models: expliciete modelcatalogusvermeldingen van de provider.models.providers.*.models.*.input: modelinvoermodaliteiten. Gebruik["text"]voor modellen met alleen tekst en["text", "image"]voor native image-/vision-modellen. Afbeeldingsbijlagen worden alleen in agentbeurten geïnjecteerd wanneer het geselecteerde model als image-geschikt is gemarkeerd.models.providers.*.models.*.contextWindow: metadata van het native modelcontextvenster. Dit overschrijftcontextWindowop providerniveau voor dat model.models.providers.*.models.*.contextTokens: optionele runtime-contextlimiet. Dit overschrijftcontextTokensop providerniveau; gebruik dit wanneer je een kleiner effectief contextbudget wilt dan de nativecontextWindowvan het model;openclaw models listtoont beide waarden wanneer ze verschillen.models.providers.*.models.*.compat.supportsDeveloperRole: optionele compatibiliteitshint. Voorapi: "openai-completions"met een niet-lege niet-nativebaseUrl(host nietapi.openai.com) forceert OpenClaw dit tijdens runtime naarfalse. Lege/weggelatenbaseUrlbehoudt standaard OpenAI-gedrag.models.providers.*.models.*.compat.requiresStringContent: optionele compatibiliteitshint voor string-only OpenAI-compatibele chat-endpoints. Wanneertrue, maakt OpenClaw pure tekst-messages[].content-arrays vlak tot gewone strings voordat de aanvraag wordt verzonden.models.providers.*.models.*.compat.strictMessageKeys: optionele compatibiliteitshint voor strikte OpenAI-compatibele chat-endpoints. Wanneertrue, beperkt OpenClaw uitgaande Chat Completions-berichtobjecten totroleencontentvoordat de aanvraag wordt verzonden.models.providers.*.models.*.compat.thinkingFormat: optionele hint voor thinking-payload. Gebruik"qwen"voorenable_thinkingop topniveau, of"qwen-chat-template"voorchat_template_kwargs.enable_thinkingop Qwen-familie OpenAI-compatibele servers die chat-template-kwargs op aanvraagniveau ondersteunen, zoals vLLM.
Amazon Bedrock-discovery
Amazon Bedrock-discovery
plugins.entries.amazon-bedrock.config.discovery: root van Bedrock-instellingen voor automatische discovery.plugins.entries.amazon-bedrock.config.discovery.enabled: impliciete discovery in-/uitschakelen.plugins.entries.amazon-bedrock.config.discovery.region: AWS-regio voor discovery.plugins.entries.amazon-bedrock.config.discovery.providerFilter: optioneel provider-id-filter voor gerichte discovery.plugins.entries.amazon-bedrock.config.discovery.refreshInterval: pollinginterval voor discovery-vernieuwing.plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow: fallback-contextvenster voor ontdekte modellen.plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens: fallbackmaximum voor uitvoertokens voor ontdekte modellen.
--custom-image-input door om metadata voor afbeeldingsgeschikte modellen af te dwingen of --custom-text-input om metadata voor alleen tekst af te dwingen.
Providervoorbeelden
Cerebras (GLM 4.7 / GPT OSS)
Cerebras (GLM 4.7 / GPT OSS)
De meegeleverde Gebruik
cerebras-provider-Plugin kan dit configureren via openclaw onboard --auth-choice cerebras-api-key. Gebruik expliciete providerconfiguratie alleen wanneer je standaardwaarden overschrijft.cerebras/zai-glm-4.7 voor Cerebras; zai/glm-4.7 voor Z.AI direct.Kimi Coding
Kimi Coding
openclaw onboard --auth-choice kimi-code-api-key.Lokale modellen (LM Studio)
Lokale modellen (LM Studio)
Zie Lokale modellen. Kort gezegd: draai een groot lokaal model via de LM Studio Responses API op serieuze hardware; houd gehoste modellen samengevoegd als fallback.
MiniMax M2.7 (direct)
MiniMax M2.7 (direct)
MINIMAX_API_KEY in. Snelkoppelingen: openclaw onboard --auth-choice minimax-global-api of openclaw onboard --auth-choice minimax-cn-api. De modelcatalogus gebruikt standaard alleen M2.7. Op het Anthropic-compatibele streamingpad schakelt OpenClaw MiniMax-denken standaard uit, tenzij je zelf expliciet thinking instelt. /fast on of params.fastMode: true herschrijft MiniMax-M2.7 naar MiniMax-M2.7-highspeed.Moonshot AI (Kimi)
Moonshot AI (Kimi)
baseUrl: "https://api.moonshot.cn/v1" of openclaw onboard --auth-choice moonshot-api-key-cn.Native Moonshot-eindpunten adverteren compatibiliteit met streaminggebruik op het gedeelde openai-completions-transport, en OpenClaw baseert dat op eindpuntmogelijkheden in plaats van alleen op de ingebouwde provider-ID.OpenCode
OpenCode
OPENCODE_API_KEY (of OPENCODE_ZEN_API_KEY) in. Gebruik opencode/...-refs voor de Zen-catalogus of opencode-go/...-refs voor de Go-catalogus. Snelkoppeling: openclaw onboard --auth-choice opencode-zen of openclaw onboard --auth-choice opencode-go.Synthetic (Anthropic-compatibel)
Synthetic (Anthropic-compatibel)
/v1 weglaten (de Anthropic-client voegt die toe). Snelkoppeling: openclaw onboard --auth-choice synthetic-api-key.Z.AI (GLM-4.7)
Z.AI (GLM-4.7)
ZAI_API_KEY in. z.ai/* en z-ai/* worden geaccepteerd als aliassen. Snelkoppeling: openclaw onboard --auth-choice zai-api-key.- Algemeen eindpunt:
https://api.z.ai/api/paas/v4 - Coding-eindpunt (standaard):
https://api.z.ai/api/coding/paas/v4 - Definieer voor het algemene eindpunt een aangepaste provider met de overschrijving voor de basis-URL.
Gerelateerd
- Configuratie — agents
- Configuratie — kanalen
- Configuratiereferentie — andere sleutels op topniveau
- Tools en plugins