UpdatePolarClawAgent

Updates a PolarClaw agent.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	pa-**************
AgentId	string	Yes	The ID of the agent to update.	work
Name	string	No	The new display name of the agent.	Work Bot
Workspace	string	No	The new working directory path.	/home/node/.openclaw/workspace-work-v2
Model	string	No	The model override.	claude-sonnet-4-5
Avatar	string	No	The new avatar.	test
Files	array<object>	No	The list of files to update.	[{"FileName":"SOUL.md","FileContent":"You are a helpful assistant."}]
	object	No	The file list.
FileName	string	No	The file name. The value must be one of the following allowed file names: AGENTS.md, SOUL.md, TOOLS.md, IDENTITY.md, USER.md, HEARTBEAT.md, BOOTSTRAP.md, MEMORY.md, or MEMORY.alt.md.	SOUL.md
FileContent	string	No	The file content.	You are a helpful assistant.
Restart	boolean	No	Specifies whether to restart the gateway after creation. Default value: true.	true
IsDefault	boolean	No	Specifies whether to set the agent as the default agent.	true
KeepWorkspaceFiles	boolean	No	Specifies whether to keep files when switching the workspace.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	CDB3258F-B5DE-43C4-8935-CBA0CA******
Message	string	The response message.	successful
Code	integer	The response status code.	200
ApplicationId	string	The application ID.	pa-**************
AgentId	string	Agent ID	main
Agent	object	The details of the updated agent.
Id	string	Agent ID	main
Name	string	The display name of the agent.	PolarClaw
Identity	object	The identity information.
Name	string	Identity name	PolarClaw
Theme	string	Theme	soul lobster
Emoji	string	Emoji identifier (Unicode format such as U+1F99E, or direct emoji character)	U+1F99E
Avatar	string	Avatar path or content	test
AvatarUrl	string	Avatar URL	test
Workspace	string	The working directory path.	/home/node/.openclaw/workspace-work-v2

Examples

Success response

JSON format

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "AgentId": "main",
  "Agent": {
    "Id": "main",
    "Name": "PolarClaw",
    "Identity": {
      "Name": "PolarClaw",
      "Theme": "soul lobster",
      "Emoji": "U+1F99E",
      "Avatar": "test",
      "AvatarUrl": "test"
    },
    "Workspace": "/home/node/.openclaw/workspace-work-v2"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.