Skip to main content
GET
List a directory on a volume

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

volume_id
string
required

Id of the volume, as returned by create.

Pattern: ^vol_

Query Parameters

path
string
default:/

Path on the volume, relative to its root, with or without a leading slash: skills/review.md and /skills/review.md name the same file. A .. segment is rejected. Leave it out for the volume's root.

Maximum string length: 4096

Response

The entries.

entries
object[]
required

The directory's immediate entries, sorted by name.