Files

List Files

GET /api/v1/workspaces/{workspaceId}/storage

string

default:"all"

all · images · deliverables · documents · files

number

default:"50"

Capped at 200.

string

Filename search (partial match).

StorageFile[]

Show StorageFile

string

image · deliverable · document · file

string

number | null

string | null

Human-readable origin label

string | null

App ID, run ID, or upload ID that produced this file

string | null

Signed S3 URL, valid 15 minutes

string

Logical path in the workspace tree (type: "file" only)

boolean

string

none · queued · processing · ready · failed

boolean

True if this file was imported from GitHub

object

GitHub repo/branch/commit metadata, if applicable

object

{ images, deliverables, documents, files } counts

boolean

curl "https://suite.sundaypyjamas.com/api/v1/workspaces/ws_123/storage?type=documents&limit=20" \
  -H "Authorization: Bearer spj_ai_your_api_key_here"

Get File Content

GET /api/v1/workspaces/{workspaceId}/storage/content

string

required

string

required

image · deliverable · document · file

Streams the raw file with Content-Type set to the stored MIME type and Content-Disposition: inline.

curl "https://suite.sundaypyjamas.com/api/v1/workspaces/ws_123/storage/content?fileId=file_1&fileType=document" \
  -H "Authorization: Bearer spj_ai_your_api_key_here" \
  -o downloaded-file.pdf

Move or Rename File

PATCH /api/v1/workspaces/{workspaceId}/storage/files/{fileId}

string

default:"rename"

move or rename

string

Required when action is move.

string

Required when action is rename.

curl -X PATCH https://suite.sundaypyjamas.com/api/v1/workspaces/ws_123/storage/files/file_1 \
  -H "Authorization: Bearer spj_ai_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "action": "move", "destFolderPath": "/archive" }'

{ "file": { "id": "file_1", "filename": "report.pdf", "path": "/archive/report.pdf", "...": "..." } }

There is also a bulk variant of this operation at PATCH /api/v1/workspaces/{workspaceId}/storage/files — same body shape, plus a top-level fileId field to select the target file.

Errors

Status	Error
400	`fileId is required` / `destFolderPath is required for move` / `newName is required for rename`
400	`Missing fileId or fileType` (Get Content)
401	`Unauthorized`
404	`File not found` / `Storage key not found` / `Empty file`

Chat

Agents

RAG

Artifacts

Image

Vector Store

Apps

Storage

Integrations

Insights

Platform Tools

List Files

Get File Content

Move or Rename File

Errors

​List Files

​Get File Content

​Move or Rename File

​Errors

List Files

Get File Content

Move or Rename File

Errors