Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
tools.*-configuratiesleutels en aangepaste provider- / base-URL-instelling. Zie voor agents, kanalen en andere configuratiesleutels op topniveau de Configuratiereferentie.
Hulpmiddelen
Hulpmiddelprofielen
tools.profile stelt een basis-toelatingslijst in vóór tools.allow/tools.deny:
Lokale onboarding stelt nieuwe lokale configuraties standaard in op
tools.profile: "coding" wanneer dit niet is ingesteld (bestaande expliciete profielen blijven behouden).| Profiel | Bevat |
|---|---|
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 | cron, gateway |
group:messaging | message |
group:nodes | nodes |
group:agents | agents_list |
group:media | image, image_generate, video_generate, tts |
group:openclaw | Alle ingebouwde hulpmiddelen (exclusief provider-Plugins) |
tools.allow / tools.deny
Globaal toestaan/weigeren-beleid voor hulpmiddelen (weigeren wint). Niet hoofdlettergevoelig, ondersteunt *-wildcards. Wordt ook toegepast wanneer de Docker-sandbox uit staat.
tools.byProvider
Beperk hulpmiddelen verder voor specifieke providers of modellen. Volgorde: basisprofiel → providerprofiel → toestaan/weigeren.
tools.elevated
Regelt verhoogde exec-toegang buiten de sandbox:
- Override per agent (
agents.list[].tools.elevated) kan alleen verder beperken. /elevated on|off|ask|fullslaat de status per sessie op; inline instructies gelden voor één bericht.- Verhoogde
execomzeilt sandboxing en gebruikt het geconfigureerde escape-pad (standaardgateway, ofnodewanneer hetexec-doelnodeis).
tools.exec
tools.loopDetection
Veiligheidscontroles voor hulpmiddellussen zijn standaard uitgeschakeld. Stel enabled: true in om detectie te activeren. Instellingen kunnen globaal worden gedefinieerd in tools.loopDetection en per agent worden overschreven op agents.list[].tools.loopDetection.
Maximale bewaarde geschiedenis van hulpmiddelaanroepen voor lusanalyse.
Drempel voor waarschuwingen bij herhalend patroon zonder voortgang.
Hogere herhalingsdrempel voor het blokkeren van kritieke lussen.
Harde stopdrempel voor elke uitvoering zonder voortgang.
Waarschuw bij herhaalde aanroepen met hetzelfde hulpmiddel/dezelfde argumenten.
Waarschuw/blokkeer bij bekende pollinghulpmiddelen (
process.poll, command_status, enz.).Waarschuw/blokkeer bij afwisselende paarsgewijze patronen zonder voortgang.
tools.web
tools.media
Configureert begrip van inkomende media (afbeelding/audio/video):
Media model entry fields
Media model entry fields
Providervermelding (
type: "provider" of weggelaten):provider: API-provider-id (openai,anthropic,google/gemini,groq, enz.)model: overschrijving van model-idprofile/preferredProfile: profielselectie voorauth-profiles.json
type: "cli"):command: uitvoerbaar bestand om uit te voerenargs: args met sjabloonwaarden (ondersteunt{{MediaPath}},{{Prompt}},{{MaxChars}}, enz.;openclaw doctor --fixmigreert verouderde{input}-placeholders naar{{MediaPath}})
capabilities: optionele lijst (image,audio,video). Standaardwaarden:openai/anthropic/minimax→ afbeelding,google→ afbeelding+audio+video,groq→ audio.prompt,maxChars,maxBytes,timeoutSeconds,language: overschrijvingen per vermelding.tools.media.image.timeoutSecondsen overeenkomende vermeldingen voor afbeeldingsmodellen mettimeoutSecondszijn ook van toepassing wanneer de agent de explicieteimage-tool aanroept.- Fouten vallen terug op de volgende vermelding.
auth-profiles.json → omgevingsvariabelen → models.providers.*.apiKey.Velden voor asynchrone voltooiing:asyncCompletion.directSend: wanneertrue, proberen voltooide asynchronemusic_generate- envideo_generate-taken eerst rechtstreekse levering aan het kanaal. Standaard:false(legacy pad voor requester-session wake/modellevering).
tools.agentToAgent
tools.sessions
Bepaalt welke sessies door de sessietools kunnen worden getarget (sessions_list, sessions_history, sessions_send).
Standaard: tree (huidige sessie + sessies die daardoor zijn gestart, zoals subagenten).
Visibility scopes
Visibility scopes
self: alleen de huidige sessiesleutel.tree: huidige sessie + sessies die door de huidige sessie zijn gestart (subagenten).agent: elke sessie die bij de huidige agent-id hoort (kan andere gebruikers omvatten als u sessies per afzender onder dezelfde agent-id uitvoert).all: elke sessie. Targeting tussen agents vereist nog steedstools.agentToAgent.- Sandbox-afklemming: 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 ondersteuning voor inline bijlagen voor sessions_spawn.
Attachment notes
Attachment notes
- Bijlagen worden alleen ondersteund voor
runtime: "subagent". ACP-runtime weigert ze. - Bestanden worden in de onderliggende workspace gematerialiseerd op
.openclaw/attachments/<uuid>/met een.manifest.json. - Inhoud van bijlagen wordt automatisch geredigeerd uit transcriptpersistentie.
- Base64-invoer wordt gevalideerd met strikte controles op alfabet/padding en een groottebeveiliging vóór het decoderen.
- Bestandsmachtigingen zijn
0700voor mappen en0600voor bestanden. - Opschonen volgt het
cleanup-beleid:deleteverwijdert bijlagen altijd;keepbehoudt ze alleen wanneerretainOnSessionKeep: true.
tools.experimental
Experimentele ingebouwde toolvlaggen. Standaard uit, tenzij een regel voor automatisch inschakelen van strict-agentic GPT-5 van toepassing is.
planTool: schakelt de gestructureerde toolupdate_planin voor het volgen van niet-triviaal werk met meerdere stappen.- 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 af te dwingen, of opfalseom deze uitgeschakeld te houden, zelfs voor strict-agentic GPT-5-runs. - Wanneer ingeschakeld, voegt de systeemprompt ook gebruiksrichtlijnen toe zodat het model de tool alleen gebruikt voor substantieel werk 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: standaard allowlist van doelagent-id’s voorsessions_spawnwanneer de aanvragende agent geen eigensubagents.allowAgentsinstelt (["*"]= elk; standaard: alleen dezelfde agent).runTimeoutSeconds: standaardtimeout (seconden) voorsessions_spawnwanneer de toolaanroeprunTimeoutSecondsweglaat.0betekent geen timeout.- 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 de configuratie of ~/.openclaw/agents/<agentId>/agent/models.json.
Verificatie en merge-voorrang
Verificatie en merge-voorrang
- Gebruik
authHeader: true+headersvoor aangepaste verificatiebehoeften. - Overschrijf de hoofdmap van de agentconfiguratie met
OPENCLAW_AGENT_DIR(ofPI_CODING_AGENT_DIR, een alias voor een verouderde omgevingsvariabele). - Merge-voorrang voor overeenkomende provider-ID’s:
- Niet-lege waarden voor
baseUrlin agent-models.jsonwinnen. - Niet-lege agentwaarden voor
apiKeywinnen alleen wanneer die provider niet door SecretRef wordt beheerd in de huidige configuratie-/auth-profielcontext. - Door SecretRef beheerde providerwaarden voor
apiKeyworden vernieuwd vanuit bronmarkeringen (ENV_VAR_NAMEvoor env-verwijzingen,secretref-managedvoor file-/exec-verwijzingen) in plaats van opgeloste geheimen te bewaren. - Door SecretRef beheerde providerheaderwaarden worden vernieuwd vanuit bronmarkeringen (
secretref-env:ENV_VAR_NAMEvoor env-verwijzingen,secretref-managedvoor file-/exec-verwijzingen). - Lege of ontbrekende agentwaarden voor
apiKey/baseUrlvallen terug opmodels.providersin de configuratie. - Overeenkomende modelwaarden voor
contextWindow/maxTokensgebruiken de hogere waarde van expliciete configuratie en impliciete cataloguswaarden. - Overeenkomende modelwaarden voor
contextTokensbehouden een expliciete runtimecap wanneer aanwezig; gebruik dit om effectieve context te beperken zonder native modelmetadata te wijzigen. - Gebruik
models.mode: "replace"wanneer je wilt dat de configuratiemodels.jsonvolledig herschrijft. - Markeringspersistentie is bronauthoritatief: markeringen worden geschreven vanuit de actieve bronconfiguratiesnapshot (voor resolutie), niet vanuit opgeloste runtimegeheimwaarden.
- Niet-lege waarden voor
Details van providervelden
Catalogus op topniveau
Catalogus op topniveau
models.mode: gedrag van providercatalogus (mergeofreplace).models.providers: aangepaste providermap, gesleuteld 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 verificatie
Providerverbinding en verificatie
models.providers.*.api: aanvraagadapter (openai-completions,openai-responses,anthropic-messages,google-generative-ai, enz.). Gebruik voor zelfgehoste/v1/chat/completions-backends zoals MLX, vLLM, SGLang en de meeste OpenAI-compatibele lokale serversopenai-completions. Een aangepaste provider metbaseUrlmaar zonderapivalt standaard terug opopenai-completions; stelopenai-responsesalleen in wanneer de backend/v1/responsesondersteunt.models.providers.*.apiKey: providerreferentie (bij voorkeur SecretRef/env-substitutie).models.providers.*.auth: verificatiestrategie (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 runtimecontextcap voor modellen onder deze provider wanneer de modelvermelding geencontextTokensinstelt.models.providers.*.maxTokens: standaard uitvoertokencap voor modellen onder deze provider wanneer de modelvermelding geenmaxTokensinstelt.models.providers.*.timeoutSeconds: optionele HTTP-aanvraagtimeout per providermodel 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: dwing referentietransport af in de headerAuthorizationwanneer vereist.models.providers.*.baseUrl: basis-URL van de upstream-API.models.providers.*.headers: extra statische headers voor proxy-/tenantroutering.
Overrides voor aanvraagtransport
Overrides voor aanvraagtransport
models.providers.*.request: transportoverrides voor HTTP-aanvragen aan modelproviders.request.headers: extra headers (samengevoegd met providerstandaarden). Waarden accepteren SecretRef.request.auth: override voor verificatiestrategie. Modi:"provider-default"(gebruik de ingebouwde verificatie van de provider),"authorization-bearer"(mettoken),"header"(metheaderName,value, optioneelprefix).request.proxy: override voor HTTP-proxy. Modi:"env-proxy"(gebruik env-varsHTTP_PROXY/HTTPS_PROXY),"explicit-proxy"(meturl). Beide modi accepteren een optioneel subobjecttls.request.tls: TLS-override voor directe verbindingen. Velden:ca,cert,key,passphrase(allemaal accepteren SecretRef),serverName,insecureSkipVerify.request.allowPrivateNetwork: wanneertrue, HTTPS naarbaseUrltoestaan wanneer DNS naar private, CGNAT- of vergelijkbare bereiken resolveert, via de HTTP-fetchguard van de provider (operator opt-in voor vertrouwde zelfgehoste OpenAI-compatibele eindpunten). Stream-URL’s voor loopback-modelproviders zoalslocalhost,127.0.0.1en[::1]worden automatisch toegestaan, tenzij dit expliciet is ingesteld opfalse; 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 vermeldingen in de providermodelcatalogus.models.providers.*.models.*.input: invoermodaliteiten van het model. 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-capable is gemarkeerd.models.providers.*.models.*.contextWindow: native metadata voor het contextvenster van het model. Dit overschrijftcontextWindowop providerniveau voor dat model.models.providers.*.models.*.contextTokens: optionele runtimecontextcap. Dit overschrijftcontextTokensop providerniveau; gebruik dit wanneer je een kleiner effectief contextbudget wilt dan het 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) dwingt OpenClaw dit tijdens runtime af naarfalse. Een lege/weggelatenbaseUrlbehoudt standaard OpenAI-gedrag.models.providers.*.models.*.compat.requiresStringContent: optionele compatibiliteitshint voor OpenAI-compatibele chat-eindpunten met alleen strings. Wanneertrue, vlakt OpenClaw pure tekstarraysmessages[].contentaf naar gewone strings voordat de aanvraag wordt verzonden.
Amazon Bedrock-detectie
Amazon Bedrock-detectie
plugins.entries.amazon-bedrock.config.discovery: hoofdmap voor instellingen voor automatische Bedrock-detectie.plugins.entries.amazon-bedrock.config.discovery.enabled: impliciete detectie in-/uitschakelen.plugins.entries.amazon-bedrock.config.discovery.region: AWS-regio voor detectie.plugins.entries.amazon-bedrock.config.discovery.providerFilter: optioneel provider-id-filter voor gerichte detectie.plugins.entries.amazon-bedrock.config.discovery.refreshInterval: pollinginterval voor detectievernieuwing.plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow: fallback-contextvenster voor gedetecteerde modellen.plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens: fallback voor maximaal aantal uitvoertokens voor gedetecteerde modellen.
--custom-image-input mee om image-capable metadata 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 gebundelde provider-Plugin Gebruik
cerebras kan dit configureren via openclaw onboard --auth-choice cerebras-api-key. Gebruik expliciete providerconfiguratie alleen wanneer je standaarden 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. TL;DR: voer een groot lokaal model uit via de LM Studio Responses API op serieuze hardware; houd gehoste modellen samengevoegd voor 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 thinking zelf expliciet 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-endpoints adverteren compatibiliteit met streaminggebruik op het gedeelde openai-completions-transport, en OpenClaw baseert dat op endpointmogelijkheden 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.Synthetisch (Anthropic-compatibel)
Synthetisch (Anthropic-compatibel)
/v1 weglaten (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/* zijn geaccepteerde aliassen. Snelkoppeling: openclaw onboard --auth-choice zai-api-key.- Algemeen endpoint:
https://api.z.ai/api/paas/v4 - Coding-endpoint (standaard):
https://api.z.ai/api/coding/paas/v4 - Definieer voor het algemene endpoint een aangepaste provider met de basis-URL-override.
Gerelateerd
- Configuratie — agents
- Configuratie — channels
- Configuratiereferentie — andere sleutels op topniveau
- Tools en plugins