Agent workspace files
Use the console to set initial AGENTS.md, SOUL.md, IDENTITY.md, and
USER.md contents when creating an Agent, then edit them in its live workspace
after deployment. These files are separate from the Configuration draft and
AgentRevision.
Set files when creating an Agent
- Open Agents in the intended Namespace and start creating an Agent.
- Open Advanced settings. In Workspace files, review the prefilled OpenClaw defaults and edit the files you want to customize. Leaving the text unchanged submits that default; clearing a field submits an empty file. Each field accepts up to 16 KiB of UTF-8 text. The browser uses LF newlines.
- Select Create Agent. Where the installation supports Dedicated provisioning, a Dedicated Agent starts provisioning and its first deployment. Otherwise, including every Embedded Agent, creation saves an undeployed draft; deploy it with Deploy new version on its Agent page. Creation saves the inputs privately, and the first deployment applies them before execution starts.
- Once the selected version has a reachable gateway, open Workspace files on the Agent and reload the files to check the contents.
If creation says that defaults changed, reload the form and review the defaults again. If deployment cannot initialize the workspace, have an operator check runtime compatibility and durable storage before retrying. Setup refuses to overwrite conflicting edits during an incomplete attempt. After completion, restarting or redeploying preserves subsequent workspace edits.
You cannot edit staged inputs on an undeployed Agent. To correct them, delete
the Agent (Delete Agent on its page, or the API; both need Agent delete)
and create it again. The initial contents reference
defines API omission, empty values, and the pinned defaults contract.
Edit a file
You need read on the Agent to load files and operate to save them. The Agent
must have a selected version and a reachable gateway. Platform workspace access
is documented for Kubernetes;
it is not available with the bundled SSH Driver.
- Open Agents, select the Agent in the intended Namespace, and open Workspace files.
- Choose Instructions (
AGENTS.md), Personality (SOUL.md), Identity (IDENTITY.md), or User context (USER.md). On a phone, use the Workspace file dropdown. Read the description above the editor to check the file's role. Switching files keeps unsaved edits. Use Reload before editing if another person might have changed the file; reloading discards that file's unsaved changes. - Edit the text, then select Save for that file. Saving creates or replaces only the selected file. Each file can contain up to 16 KiB of UTF-8 text.
- Reload the file to confirm the expected content was stored.
There is no version check: if two people edit a file, the last write wins. Do not put credentials in these files. Use a Secret for credential values.
If files cannot be loaded or saved
- Immediately after deployment: the gateway may still be starting. Confirm OCC selected the expected version and its gateway is reachable, then reload. If access stays unavailable, have an operator check workspace routing.
- A save has an unknown outcome: it may have succeeded. Reload the affected file and compare its content with your edit before saving again. A failure for one file does not establish what happened to the others.
- The request is rejected: check that the file is one of the four supported
names, your text fits the limit, and you have Agent
operatepermission.
For automation, the workspace file API documents the paths, limits, and errors.
