List Directory

curl --request GET \
  --url https://api.app.shinzo.ai/v1/agent/{agentId}/filesystem/directories/{path} \
  --header 'Authorization: Bearer <token>'

GET

agent

{agentId}

filesystem

directories

{path}

List Directory

curl --request GET \
  --url https://api.app.shinzo.ai/v1/agent/{agentId}/filesystem/directories/{path} \
  --header 'Authorization: Bearer <token>'

Authentication

Requires JWT token or Platform API key.

string

required

Agent UUID

string

required

Directory path within the agent workspace (wildcard segment)

boolean

List directory contents recursively

boolean

Include hidden files in the listing

Example Request

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

With recursive listing:

curl -X GET "https://api.app.shinzo.ai/v1/agent/agt_abc123/filesystem/directories/workspace/src?recursive=true" \
  -H "Authorization: Bearer <jwt_token>"

Response

{
  "path": "/workspace/src",
  "entries": [
    {
      "name": "index.js",
      "type": "file",
      "size": 1024,
      "modified_at": "2025-01-20T10:00:00Z"
    },
    {
      "name": "utils",
      "type": "directory",
      "size": 0,
      "modified_at": "2025-01-19T15:00:00Z"
    }
  ]
}

Response Fields

Field	Type	Description
`path`	string	Absolute path of the listed directory
`entries`	array	List of directory entries
`entries[].name`	string	Name of the file or directory
`entries[].type`	string	Entry type (`file` or `directory`)
`entries[].size`	number	Size in bytes (files only)
`entries[].modified_at`	string	Last modified timestamp (ISO 8601)

Status Codes

Code	Description
`200`	Directory contents returned successfully
`401`	Invalid authentication
`403`	Access denied
`404`	Agent or directory not found

Overview

Authentication

AI Agents

Agent Messaging

Agent Schedules & Triggers

Agent Channels

Agent Filesystem

MCP Servers

Spotlight

Tokens

Provider Keys

Telemetry

List Directory

Authentication

Example Request

Response

Response Fields

Status Codes

​Authentication

​Example Request

​Response

​Response Fields

​Status Codes

Authentication

Example Request

Response

Response Fields

Status Codes