REST base URL, auth, and resource map·View as Markdown

API overview

Agent-readable REST API for workspaces, buckets, files, intelligence, and the bucket agent.

Prefer MCP in agent clients. Use REST when you need raw HTTP.

Base URL

https://www.file.rocks/api/v1

Auth

Authorization: Bearer fr_live_...

Create keys in Settings → API keys (dogfood / intelligence allowlist only). Scopes are enforced per route. Keys may restrict bucketIds.

→ Auth · API keys guide

Resources

Quick map

• GET /workspaces — workspaces:read
• GET /workspaces/{workspaceId}/buckets — buckets:read
• GET .../buckets/{bucketId}/files?prefix=&search=&tag=&semantic=1 — files:read
• PATCH .../files/{fileId} — tags / description — files:write
• POST .../files/presign-upload · presign-download — files:upload / files:download
• GET|PATCH .../intelligence — intelligence:read|write
• POST .../intelligence/backfill — intelligence:write
• POST .../agent — agent:run
• GET .../shares · GET .../transfers

Example

curl -s -H "Authorization: Bearer $FR_KEY" \
  https://www.file.rocks/api/v1/workspaces/$WS/buckets | jq