Skip to main content
GET
/
v1
/
agent
/
{agentId}
/
filesystem
/
metadata
/
{path}
Get File Metadata
curl --request GET \
  --url https://api.app.shinzo.ai/v1/agent/{agentId}/filesystem/metadata/{path} \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authentication

Requires JWT token or Platform API key.
agentId
string
required
Agent UUID
path
string
required
File or directory path within the agent workspace (wildcard segment)

Example Request

curl -X GET "https://api.app.shinzo.ai/v1/agent/agt_abc123/filesystem/metadata/workspace/src/index.js" \
  -H "Authorization: Bearer <jwt_token>"

Response

{
  "path": "/workspace/src/index.js",
  "type": "file",
  "size": 1024,
  "permissions": "644",
  "created_at": "2025-01-15T10:00:00Z",
  "modified_at": "2025-01-20T12:30:00Z"
}

Response Fields

FieldTypeDescription
pathstringAbsolute path of the file or directory
typestringEntry type (file or directory)
sizenumberSize in bytes
permissionsstringFile permissions in octal format
created_atstringCreation timestamp (ISO 8601)
modified_atstringLast modified timestamp (ISO 8601)

Status Codes

CodeDescription
200Metadata returned successfully
401Invalid authentication
403Access denied
404Agent or path not found