DescribePolarClawAgentFile

Queries a PolarClaw Agent file.

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-xxx
AgentId	string	Yes	Agent ID	main
FileName	string	Yes	The file name.	SOUL.md

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	F45FFACC-xxx
Message	string	The response message.	success
Code	integer	The response status code.	200
ApplicationId	string	The application ID.	pa-xxx
AgentId	string	Agent ID	main
Workspace	string	The working directory path.	/home/node/.openclaw/workspace-main
File	object	The file details.
Name	string	The file name.	SOUL.md
Path	string	The file path.	/home/node/.openclaw/workspace-main/SOUL.md
Missing	boolean	Indicates whether the file is missing.	false
Size	integer	The file size, in bytes.	1024
UpdatedAtMs	integer	The last updated UNIX timestamp, in milliseconds.	1716000000000
Content	string	The file content.	You are a helpful assistant.

Examples

Success response

JSON format

{
  "RequestId": "F45FFACC-xxx",
  "Message": "success",
  "Code": 200,
  "ApplicationId": "pa-xxx",
  "AgentId": "main",
  "Workspace": "/home/node/.openclaw/workspace-main",
  "File": {
    "Name": "SOUL.md",
    "Path": "/home/node/.openclaw/workspace-main/SOUL.md",
    "Missing": false,
    "Size": 1024,
    "UpdatedAtMs": 1716000000000,
    "Content": "You are a helpful assistant."
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.