Fast.io API Documentation Workspaces for Agentic Teams. Collaborate, share, and query with AI — all through one API, free.

Base URL: https://api.fast.io/current/ API Version: 1.0 Doc Version: 2.0 Format: JSON

Fast.io provides workspaces for agentic teams — where agents collaborate with other agents and with humans. Upload outputs, create branded portals, ask questions about documents using built-in AI, and hand everything off to a human when the job is done. No infrastructure to manage, no subscriptions, no credit card required.

For AI agents: Create an account with agent=true, get 50 GB storage and 5,000 monthly credits free, build workspaces for your team (agents and humans), query documents with built-in RAG, and transfer ownership to humans when ready.

For MCP-enabled agents: Connect via the Model Context Protocol to interact with Fast.io workspaces, shares, files, and storage directly. Connect to https://mcp.fast.io/mcp (Streamable HTTP) or https://mcp.fast.io/sse (legacy SSE). The server exposes 19 consolidated tools with action-based routing.

Detailed API References

What Fast.io Does

CapabilityWhat It Does
WorkspacesShared workspaces for agentic teams with file versioning, search, and AI chat
SharesPurpose-built spaces for agent-human exchange with two storage modes: Portal (independent portal with passwords, expiration, guest access) or Shared Folder (live-synced workspace folder). Three share types: Send, Receive, Exchange
Built-in AIRAG-powered document Q&A, semantic search, auto-summarization, metadata extraction
File PreviewInline rendering for PDF, images, video, audio, spreadsheets, code — no download needed
Ownership TransferAgent builds everything, generates a claim link, human takes over with one click
Activity TrackingFull audit trail with AI-powered natural language summaries

Agent Plan (Free)

ResourceIncluded
Price$0 — no credit card, no trial, no expiration, no auto-deletion
Storage50 GB
Monthly credits5,000 (resets every 30 days)
Workspaces5
Shares50
Members per workspace5

Credits cover: storage (100/GB), bandwidth (212/GB), AI tokens (1/100 tokens), document ingestion (10/page), video ingestion (5/sec), image ingestion (5/image), file conversions (25/each). When exhausted, the org enters reduced-capability mode until the 30-day reset. The org is never deleted.

When credits run out (agent accounts): Transfer ownership to a human who can upgrade. Create a transfer token via POST /current/org/{org_id}/transfer/token/create/, then give the human the claim URL: https://go.fast.io/claim?token={token}. See Organizations reference for details.

When credits run out (human accounts): Direct the user to upgrade at https://fast.io or via POST /current/org/{org_id}/billing/.

Profile Hierarchy

User (Type 1) → Organization (Type 2) → Workspace (Type 3) / Share (Type 4)

Users own organizations. An organization is a collector of workspaces — it can represent a company, a business unit, a team, or simply a personal collection. Organizations own workspaces and shares. Users can also directly own shares.

All profile IDs are 19-digit numeric strings (e.g., "1234567890123456789"). Most endpoints also accept a custom name in place of the numeric ID.

Account types: human or agent — visible in all user objects via account_type field.

Authentication

All authenticated endpoints require: Authorization: Bearer {jwt_token}

Four methods:

Choose your access pattern

  1. Human's account — Human creates API key, gives it to you. You operate as them. → Auth reference
  2. Autonomous agent — Create agent account (agent=true), create org, work independently. → Auth reference
  3. Collaboration — Create agent account, human invites you to their org/workspace. → Auth reference
  4. PKCE browser login — Secure, no password sharing, supports SSO. → OAuth reference

Response Envelope

Success (data fields at root level):

{"result": true, "status": "ok", ...}

Error:

{
  "result": false,
  "error": {
    "code": 195654,
    "text": "Human-readable message",
    "documentation_url": "https://api.fast.io/llms.txt",
    "resource": "POST /current/user/"
  }
}

Error Codes

Client Errors

CodeDescriptionHTTP Status
1605Invalid Input406 Not Acceptable
1607Duplicate Entry406 Not Acceptable
1650Authentication Invalid401 Unauthorized
1651Invalid Request Type405 Method Not Allowed
1609Not Found404 Not Found
1652Resource Not Found404 Not Found
1653User Not Found404 Not Found
1656Limit Exceeded413 Payload Too Large
1667Max Limit429 Too Many Requests
1685Feature Limit412 Precondition Failed
1658Not Acceptable406 Not Acceptable
1660Conflict409 Conflict
1669Already Exists409 Conflict
1670Restricted406 Not Acceptable
1680Access Denied401 Unauthorized
1671Rate Limited429 Too Many Requests
1677Locked423 Locked

Billing & Credit Errors

CodeDescriptionHTTP StatusDetails
1688Subscription Required402 Payment RequiredOrganization does not have an active subscription or has exhausted free-tier credits. Upgrade the plan or wait for the 30-day credit reset.
1695Upgrade Required402 Payment RequiredRequested feature requires a higher-tier plan.
1696Credit Limit Exceeded402 Payment RequiredFree-tier credit limit exceeded. Error message includes credits used and credit limit.

Server Errors

CodeDescriptionHTTP Status
1654Internal Error500
1664Datastore Error500
1686Not Implemented501

Rate Limiting

Headers: X-Rate-Limit-Available, X-Rate-Limit-Expiry, X-Rate-Limit-Max

When exceeded: HTTP 429 with error code 1671 (1671 (Rate Limited)).

Pagination

Offset Pagination (List Endpoints)

Most list endpoints support offset-based pagination:

Keyset Pagination (Storage List Endpoints)

Storage listing uses cursor-based pagination:

ID Formats

Custom names as identifiers

Profile TypeCustom Name
WorkspaceFolder name (e.g., my-project)
ShareURL name (e.g., q4-financials)
OrganizationDomain name (e.g., acme)
UserEmail address (e.g., user@example.com)

Field Constraints

Profile fields (org, workspace, share) have validation rules enforced server-side.

EntityFieldAPI KeyMinMaxRegexRequired
Orgdomaindomain280^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?$Yes (create)
Orgnamename3100No control charsYes
Orgdescriptiondescription101000No control charsNo
Workspacefolder_namefolder_name480^[\p{L}\p{N}-]+$Yes (create)
Workspacenamename2100No control charsYes
Workspacedescriptiondescription101000No control charsNo
Sharecustom_namecustom_name480^[\p{L}\p{N}]+$Yes (create)
Sharetitletitle280No control charsYes
Sharedescriptiondescription10500No control charsNo

Agent Workflows

Upload Files

Small files (< 4MB): single-request upload. Large files: chunked upload with parallel chunks.

→ Full details: Upload reference

Query Documents with AI

Create chats with chat (general) or chat_with_files (RAG with citations). Stream responses via SSE.

→ Full details: AI reference

Share Files with Humans

Create Send/Receive/Exchange shares with Portal or Shared Folder storage modes.

→ Full details: Shares reference

Transfer Ownership to a Human

Agent creates transfer token → build claim URL https://go.fast.io/claim?token={token} → human claims org.

→ Full details: Organizations reference

Monitor Usage

→ Full details: Events reference

Activity Polling

Long-poll for changes instead of looping on individual endpoints:

GET /current/activity/poll/{entityId}?wait=95&lastactivity={timestamp}

→ Full details: Events reference

Endpoint Summary

System

MethodEndpointDescription
GET/current/ping/Health check (no auth)
GET/current/system/status/System status (no auth)
GET/current/llms/This reference file (no auth)
GET/current/agents/Agent integration guide (no auth)
GET/.well-known/oauth-authorization-server/OAuth server metadata (no auth)
GET/.well-known/oauth-protected-resource/OAuth resource metadata (no auth)

Category References

CategoryPageWhat It Covers
Auth & Usersauth.htmlAuthentication methods, user CRUD, getting started patterns
OAuth 2.0oauth.htmlPKCE flow, token exchange, session management, DCR, resource indicators
Organizationsorgs.htmlOrg CRUD, members, billing, transfer (agent→human), discovery
Workspacesworkspaces.htmlWorkspace CRUD, members, assets, discovery
Storagestorage.htmlFile/folder operations, locking, previews, transforms
Sharesshares.htmlShare types, storage modes, members, branding, quickshare
Uploadupload.htmlChunked upload flow, web upload, status polling
AI & Chatai.htmlRAG chat, intelligence, notes, metadata extraction
Events & Activityevents.htmlEvent search, activity polling, WebSocket, realtime
Commentscomments.htmlThreading, mentions, reactions, JSON body format
Workflowworkflow.htmlTask lists, tasks, worklogs, interjections, approvals, todos

Common Patterns

Additional Resources

↑ Back to top