Axerity Docs
API

Folders

File workspace folders — nestable, with recursive delete.

Object shape

{
  "id": "01HW…",
  "object": "folder",
  "name": "2026 Contracts",
  "parent": null,
  "created_at": "…",
  "updated_at": "…"
}
FieldTypeNotes
parentstring | nullnull for root-level folders.

Endpoints

GET    /v1/folders                 ?parent=:id (list children; omit for root)
POST   /v1/folders                 { name, parent? }
GET    /v1/folders/:id
POST   /v1/folders/:id             { name?, parent? }   rename or move
DELETE /v1/folders/:id             recursive — deletes contents

Recursive delete

DELETE /v1/folders/:id is recursive: every sub-folder and every file inside (and inside their descendants) is permanently removed, and the underlying S3 objects are deleted. The response includes deleted_files so you know how much was cleaned up.

{
  "id": "01HW…",
  "object": "folder",
  "deleted": true,
  "deleted_files": 47
}

No undo. The audit log records each file deletion (cause: "folder_delete" in metadata) so the trail survives.

Files

On this page