CreatePolarClawAgent-阿里云帮助中心

Creates a PolarClaw Agent.

Operation description

Description

Use this operation to create a PolarClaw Agent. You can optionally specify an emoji and an avatar.

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 agent ID.	work
Workspace	string	Yes	The absolute path of the agent workspace.	/home/node/.openclaw/workspace-work
Emoji	string	No	The emoji character.	U+1F99E
Avatar	string	No	The avatar's URL or path.	test
Restart	boolean	No	Specifies whether to restart the gateway after the agent is created. The default value is `true`.	true

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
Message	string	The response message.	successful
Code	integer	The status code.	200
ApplicationId	string	The application ID.	pa-**************
AgentId	string	The agent ID.	work
Name	string	The display name of the agent.	work
Workspace	string	The workspace path.	/home/node/.openclaw/workspace-work
Agent	object	Details of the new agent.
Id	string	The agent ID.	work
Name	string	The display name of the agent.	work
Identity	object	The agent's identity.
Name	string	The identity name.	work
Theme	string	The theme.	work
Emoji	string	The emoji identifier.	U+1F99E
Avatar	string	The avatar's path or content.	test
AvatarUrl	string	The avatar URL.	test
Workspace	string	The workspace path.	/home/node/.openclaw/workspace-work

Examples

Success response

JSON format

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "AgentId": "work",
  "Name": "work",
  "Workspace": "/home/node/.openclaw/workspace-work",
  "Agent": {
    "Id": "work",
    "Name": "work",
    "Identity": {
      "Name": "work",
      "Theme": "work",
      "Emoji": "U+1F99E",
      "Avatar": "test",
      "AvatarUrl": "test"
    },
    "Workspace": "/home/node/.openclaw/workspace-work"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.