File Management

Yboard provides a file management system backed by Cloudflare R2 object storage. Files are scoped to your organization and app, with metadata tracked in a database.

Uploading files

Direct upload

Upload a file using a multipart/form-data POST request:

curl -X POST https://worker.yboard.app/{orgId}-{appId}/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "id=my-file-id" \
  -F "fileName=report.pdf" \
  -F "file=@./report.pdf" \
  -F "metadata={\"type\":\"report\"}"

Required fields:

id — A unique identifier for the file.
file — The file binary.
fileName — Display name of the file.

Optional fields:

metadata — Arbitrary JSON metadata attached to the file.

Chunked upload

For large files, Yboard supports chunked uploads. Send file data in sequential base64-encoded chunks:

{
  "fileId": "temp-upload-id",
  "fileName": "large-video.mp4",
  "chunkIndex": 0,
  "totalChunks": 10,
  "chunk": "<base64-encoded-data>"
}

Chunks must arrive in order starting from index 0. The server tracks progress and assembles the file after all chunks are received. Progress response:

{
  "success": true,
  "chunksReceived": 5,
  "totalChunks": 10,
  "nextExpectedChunk": 5
}

Completion response:

{
  "success": true,
  "id": "generated-nanoid",
  "message": "File upload completed successfully"
}

Listing files

Retrieve all files with their metadata:

curl https://worker.yboard.app/{orgId}-{appId}/files \
  -H "Authorization: Bearer YOUR_API_KEY"

Returns an array of file objects:

[
  {
    "id": "abc123",
    "name": "report.pdf",
    "metadata": { "type": "report" }
  }
]

Use the /files/metadata endpoint for the same data without file content.

Downloading files

curl https://worker.yboard.app/{orgId}-{appId}/files/{fileId}/download \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o output.pdf

Returns the file binary with appropriate Content-Type and Content-Disposition headers.

Deleting files

Single file

curl -X DELETE https://worker.yboard.app/{orgId}-{appId}/files/{fileId} \
  -H "Authorization: Bearer YOUR_API_KEY"

Batch delete

curl -X DELETE https://worker.yboard.app/{orgId}-{appId}/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "ids": ["file1", "file2", "file3"] }'

Returns a report of deleted and failed items:

{
  "deleted": ["file1", "file2"],
  "failed": [{ "id": "file3", "error": "File not found" }]
}

File metadata

Retrieve metadata for a specific file without downloading the content:

curl https://worker.yboard.app/{orgId}-{appId}/files/{fileId}/metadata \
  -H "Authorization: Bearer YOUR_API_KEY"

Storage details

Files are stored in Cloudflare R2 with keys in the format {organizationId}-{appId}-{fileId}.
Metadata (ID, filename, custom JSON) is stored in the database.
All file operations require a valid Bearer token matching the organization.

Overview

Core Features

App Management

Integrations

File Management

Uploading files

Direct upload

Chunked upload

Listing files

Downloading files

Deleting files

Single file

Batch delete

File metadata

Storage details

​Uploading files

​Direct upload

​Chunked upload

​Listing files

​Downloading files

​Deleting files

​Single file

​Batch delete

​File metadata

​Storage details

Uploading files

Direct upload

Chunked upload

Listing files

Downloading files

Deleting files

Single file

Batch delete

File metadata

Storage details