DescribePolarClawAgents

Queries all installed plug-ins and their status information under a specified application.

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-**************
AgentList	array	No	The list of agent IDs to describe.	work,research
	string	No	The agent list.	work

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	24A1990B-4F6E-482B-B8CB-75C612******
Message	string	The response message.	successful
Code	integer	The response status code.	200
ApplicationId	string	The application ID.	pa-**************
DefaultId	string	The default agent ID.	main
MainKey	string	The primary agent key name.	main
Scope	string	The routing scope.	per-sender
Agents	array<object>	The agent list.
	array<object>	Agent
Id	string	Agent ID	main
Name	string	The agent display name.	main
Identity	object	The identity information.
Name	string	The identity name.	PolarClaw
Theme	string	The theme.	space lobster
Emoji	string	The emoji identifier in Unicode encoding format such as U+1F99E, or a direct emoji character.	U+1F99E
Avatar	string	The avatar path or content.	test
AvatarUrl	string	The avatar URL.	test
Workspace	string	The working directory path.	/home/node/.openclaw/workspace-work
Default	boolean	Indicates whether this is the default agent.	true
Model	object	The model configuration.
Primary	string		claude-sonnet-4-5
Fallbacks	array
	string		claude-haiku-4-5
Skills	array	The list of skills available to the agent.
	string	The skill identifier.	alibacloud-rds-copilot
Files	array<object>	The agent file list.
	object	The file information.
Name	string		SOUL.md
Path	string		/home/node/.openclaw/workspace-work/SOUL.md
Missing	boolean		false
Size	integer		1024
UpdatedAtMs	integer		1716000000000

Examples

Success response

JSON format

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "DefaultId": "main",
  "MainKey": "main",
  "Scope": "per-sender",
  "Agents": [
    {
      "Id": "main",
      "Name": "main",
      "Identity": {
        "Name": "PolarClaw",
        "Theme": "space lobster",
        "Emoji": "U+1F99E",
        "Avatar": "test",
        "AvatarUrl": "test"
      },
      "Workspace": "/home/node/.openclaw/workspace-work",
      "Default": true,
      "Model": {
        "Primary": "claude-sonnet-4-5",
        "Fallbacks": [
          "claude-haiku-4-5"
        ]
      },
      "Skills": [
        "alibacloud-rds-copilot"
      ],
      "Files": [
        {
          "Name": "SOUL.md",
          "Path": "/home/node/.openclaw/workspace-work/SOUL.md",
          "Missing": false,
          "Size": 1024,
          "UpdatedAtMs": 1716000000000
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.