--- name: fast-io description: >- Workspaces for agentic teams. Complete agent guide with all 19 consolidated tools using action-based routing — parameters, workflows, ID formats, and constraints. Use this skill when agents need shared workspaces to collaborate with other agents and humans, create branded shares (Send/Receive/Exchange), or query documents using built-in AI. Supports ownership transfer to humans, workspace management, workflow primitives (tasks, worklogs, approvals, todos), and real-time collaboration. Free agent plan with 50 GB storage and 5,000 monthly credits. license: Proprietary compatibility: >- Requires network access. Connects to the Fast.io MCP server at mcp.fast.io via Streamable HTTP (/mcp) or SSE (/sse). metadata: author: fast-io version: "1.223.0" homepage: "https://fast.io" --- # Fast.io MCP Server -- AI Agent Guide **Version:** 1.223 **Last Updated:** 2026-05-22 The definitive guide for AI agents using the Fast.io MCP server. Covers why and how to use the platform: product capabilities, the free agent plan, authentication, core concepts (workspaces, shares, intelligence, previews, comments, URL import, metadata, workflow, ownership transfer), 12 end-to-end workflows, interactive MCP App widgets, and all 19 consolidated tools with action-based routing. > **Versioned guide.** This guide is versioned and updated with each server release. The version number at the top of this document tracks tool parameters, ID formats, and API behavior changes. If you encounter unexpected errors, the guide version may have changed since you last read it. > **Recent parameter changes (v2026.05.22 → v2026.05.23):** > - **`event` tool:** the `created-min` / `created-max` filter names were renamed to `created_min` / `created_max` (snake_case). The old hyphenated names are silently migrated to the new names by the server — existing agents continue to work. New agents should use snake_case directly. > - **`apps.extra_params`, `approval.properties`, `execute.body`, `execute.params`:** these free-form JSON parameters are now published as `{type: "string"}` in the tool schema (to satisfy strict-mode validators in OpenAI Apps SDK / Gemini API). The server still accepts either a native JSON object/array (auto-stringified) OR a pre-stringified JSON string at runtime — you can keep sending native objects from Claude Desktop and they will be auto-converted. > - **`/file/workspace|share` pass-through:** now accepts either `Mcp-Session-Id` (existing path) OR `Authorization: Bearer` (new — unblocks OAuth-only clients streaming large files without first establishing an MCP tool-auth session). Fresh Bearer tokens are used even when the DO session has a stale or expired session-stored token. > - **New `resource://status` MCP resource (v2026.05.24):** lightweight server-status resource alongside the existing `session://status` and `skill://guide` resources. Returns `{name, version, environment, transports, mcp_protocol_versions_supported, time, documentation}` — no auth, no session state. Added so MCP host UIs (ChatGPT Apps SDK in particular) that probe a well-known status URI can display server health without spending a tool call. For session-bound state continue using `session://status` (the resource) or `auth action=status` (the tool). > **Platform reference.** For a comprehensive overview of Fast.io's capabilities, the agent plan, key workflows, and upgrade paths, see [references/REFERENCE.md](references/REFERENCE.md). > **ID parameter taxonomy.** Four canonical ID parameter names appear across tools — they are intentionally distinct, not interchangeable. Pick the one that matches the operation's domain: > > - **`workspace_id`** — workspace opaque ID. Use when only workspaces are valid (not shares or other contexts). Example: `events action workspace-stream workspace_id="..."`. > - **`profile_id`** — polymorphic context ID. Pair with `profile_type` = `workspace` | `share` | `org`. Use instead of `workspace_id` when the operation also accepts shares. Example: `storage action list profile_type="share" profile_id="..." node_id="root"`. > - **`entity_id`** — opaque ID of a specific object (file, comment, worklog entry, etc.). Pair with `entity_type` to disambiguate. Example: `worklog action list entity_type="task" entity_id="..."`. > - **`node_id`** — storage tree node opaque ID. Both files and folders are nodes — use this name regardless of which. Example: `storage action details profile_type="workspace" profile_id="..." node_id="..."`. --- ## 1. Overview **Workspaces for Agentic Teams. Collaborate, share, and query with AI -- all through one API, free.** Fast.io provides workspaces for agentic teams -- where agents collaborate with other agents and with humans. Upload outputs, create branded shares, 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 to set up, no credit card required. ### The Problem Fast.io Solves Agentic teams -- groups of agents working together and with humans -- need a shared place to work. Today, agents cobble together S3 buckets, presigned URLs, email attachments, and custom download pages. Every agent reinvents collaboration, and there is no shared workspace where agents and humans can see the same files, track activity, and hand off work. When agents need to *understand* documents -- not just store them -- they have to download files, parse dozens of formats, build search indexes, and manage their own RAG pipeline. That is a lot of infrastructure for what should be a simple question: "What does this document say?" | Problem | Fast.io Solution | |---------|-----------------| | No shared workspace for agentic teams | Workspaces where agents and humans collaborate with file preview, versioning, and AI | | Agent-to-agent coordination lacks structure | Shared workspaces with activity feeds, comments, and real-time sync across team members | | Sharing outputs with humans is awkward | Purpose-built shares (Send, Receive, Exchange) with link sharing, passwords, expiration | | Collecting files from humans is harder | Receive shares let humans upload directly to your workspace -- no email attachments | | Understanding document contents | Built-in AI reads, summarizes, and answers questions about your files | | Building a RAG pipeline from scratch | Enable intelligence on a workspace and documents are automatically indexed, summarized, and queryable | | Finding the right file in a large collection | Storage search finds documents by keyword or meaning (semantic search when intelligence is enabled) | | Handing a project off to a human | One-click ownership transfer -- human gets the org, agent keeps admin access | | Tracking what happened | Full audit trail with AI-powered activity summaries | | Cost | Free. 50 GB storage, 5,000 monthly credits, no credit card | ### MCP Server This MCP server exposes 19 consolidated tools that cover the full Fast.io REST API surface. Every authenticated API endpoint has a corresponding tool action, and the server handles session management automatically. **All API access goes through the MCP tools.** Do not make direct HTTP calls to `api.fast.io` or the MCP server -- the tools handle authentication, session management, error recovery, and response formatting automatically. The only exceptions are binary transfers: `POST /blob` on the MCP server for uploads (the tool provides the curl command), download URLs returned by tools (which are pre-authenticated), and `GET /file/` pass-through endpoints on the MCP server for large file streaming. Everything else must use the tools. Once a user authenticates, the auth token is stored in the server session and automatically attached to all subsequent API calls. There is no need to pass tokens between tool invocations. ### Server Endpoints - **Production:** `mcp.fast.io` - **Development:** `mcp.fastdev1.com` Two transports are available on each: - **Streamable HTTP at `/mcp`** -- the preferred transport for new integrations. - **SSE at `/sse`** -- a legacy transport maintained for backward compatibility. ### MCP Resources The server exposes static MCP resources, widget resources, and file download resource templates. Clients can read them via `resources/list` and `resources/read`: | URI | Name | Description | MIME Type | |-----|------|-------------|-----------| | `skill://guide` | skill-guide | Full agent guide (this document) with all 19 tools, workflows, and platform documentation | `text/markdown` | | `session://status` | session-status | Current authentication state: `authenticated` boolean, `user_id`, `user_email`, `auth_method` (`"api_key"`, `"jwt"`, or `"oauth"` -- how the session was authenticated), `token_expires_at` (Unix epoch), `token_expires_at_iso` (ISO 8601), `scopes` (raw scope string or null), `scopes_detail` (array of hydrated scope objects with entity names/domains/parents, or null), `agent_name` (string or null) | `application/json` | | `resource://status` | server-status | Lightweight server health: `name`, `version`, `status`, `environment`, `transports` (`/mcp`, `/sse`), `mcp_protocol_versions_supported`, `time` (ISO 8601), `documentation` (skill guide + API + platform links). No auth required, no session state — for host UIs that probe a well-known status URI. For session-bound state use `session://status` or `auth` action `status`. | `application/json` | | `ui://fastio/*` | Widget HTML | Interactive HTML5 widgets (6 total) -- use the `apps` tool to discover and launch | `text/html` | **File download resource templates** -- read file content directly through MCP without needing external HTTP access: | URI Template | Name | Auth | Dynamic Listing | Description | |---|---|---|---|---| | `download://workspace/{workspace_id}/{node_id}` | download-workspace-file | Session token | Yes | Download a file from a workspace | | `download://share/{share_id}/{node_id}` | download-share-file | Session token | Yes | Download a file from a share | | `download://quickshare/{quickshare_id}` | download-quickshare-file | None (public) | No | Download a quickshare file | Files up to 50 MB are returned inline as base64-encoded blob content. Larger files return a text fallback with a URL to the HTTP pass-through endpoint (see below). The `download` tool responses include a `resource_uri` field with the appropriate URI for each file. **Dynamic resource listing:** When authenticated, workspace and share file resources are dynamically listed via `resources/list`. MCP clients (such as Claude Desktop's `@` mention picker) can discover available files without any tool calls. Up to 10 workspaces and 10 shares are enumerated, with up to 25 most recently updated root-level files from each. Resources appear as "WorkspaceName / filename.ext" or "ShareTitle / filename.ext". Results are cached for 1 minute per session. Only root-level files are listed -- subdirectories are not recursively enumerated. Use the `storage` tool with action `list` to browse deeper. The quickshare template remains template-only and is not dynamically enumerable. ### MCP Prompts The server registers MCP prompts that appear in the client's "Add From" / "+" menu as user-clickable app launchers. These are primarily for desktop MCP clients (e.g., Claude Desktop); code-mode clients (Claude Code, Cursor) do not surface prompts. | Prompt Name | Description | |---|---| | `App: Choose Workspace or Org` | Launch the Workspace Picker to browse orgs, select workspaces, and manage shares | | `App: Pick a File` | Launch the File Picker with built-in workspace navigator for browsing, searching, and selecting files | | `App: Open Workflow` | Launch the Workflow Manager (auto-selects workspace if only one, otherwise opens Workspace Picker first) | | `App: Upload Files` | Launch the Uploader to upload files with drag-and-drop, progress tracking, and text file creation | | `App: Available Apps` | List all available MCP App widgets with descriptions and launch instructions | ### HTTP File Pass-Through For files larger than 50 MB or when raw binary streaming is needed, the server provides an HTTP pass-through endpoint that streams file content directly from the API: | Endpoint | Auth | Description | |---|---|---| | `GET /file/workspace/{workspace_id}/{node_id}` | `Mcp-Session-Id` header | Stream a workspace file | | `GET /file/share/{share_id}/{node_id}` | `Mcp-Session-Id` header | Stream a share file | | `GET /file/quickshare/{quickshare_id}` | None (public) | Stream a quickshare file | The response includes proper `Content-Type`, `Content-Length`, and `Content-Disposition` headers from the upstream API. Errors are returned as HTML pages. The `Mcp-Session-Id` header is the same session identifier used for MCP protocol communication. ### Workflow Overview The server includes workflow features for project tracking: **tasks** (structured work items with priorities and assignees), **worklogs** (append-only activity logs), **approvals** (formal sign-off requests — see **Workflow Approvals -- Quick Start** below), and **todos** (simple checklists). Enable workflow on a workspace with `workspace` action `enable-workflow` before using these tools. See the **Full Agent Workflow** recipe in section 6 for the complete pattern. **Best practice (IMPORTANT):** After state-changing actions (uploading files, creating shares, changing task status, member changes, file moves/deletes), append a worklog entry describing what you did and why. Without worklog entries, agent work is invisible to humans reviewing the workspace. For multiple related actions (e.g., uploading several files), you may log once after the batch completes rather than after each individual action. Worklog entries are append-only and permanent. ### Additional References - **Agent guide (this file):** `/skill.md` on the MCP server -- tool documentation, workflows, and constraints. - **REST API reference:** `https://api.fast.io/llms.txt` -- endpoint documentation for the underlying REST API (reference only -- use the MCP tools, not direct HTTP calls). - **Platform guide:** [references/REFERENCE.md](references/REFERENCE.md) -- capabilities, agent plan details, key workflows, and upgrade paths. --- ## 2. Authentication (Critical First Step) Authentication is required before calling any tool except these unauthenticated tools: - `auth` with actions: `signin`, `signup`, `set-api-key`, `pkce-login`, `email-check`, `password-reset-request`, `password-reset` - `download` with action: `quickshare-details` ### Choosing the Right Approach There are three ways to use Fast.io as an agent, depending on whether you are operating autonomously or assisting an existing human user. **Option 1: Autonomous Agent -- Create an Agent Account** If you are operating independently (storing files, running workflows, building workspaces for users), create your own agent account with `auth` action `signup`. Agent accounts get the free agent plan (50 GB, 5,000 monthly credits) and can transfer orgs to humans when ready. This is the recommended path for autonomous agents. See **Agent Account Creation** below for steps. **Option 2: Assisting a Human -- Use Their API Key** If a human already has a Fast.io account and wants your help managing their files, workspaces, or shares, they can create an API key for you to use. No separate agent account is needed -- you operate as the human user. The human creates a key at Settings -> Devices & Agents -> API Keys (direct link: `https://go.fast.io/settings/api-keys`). Call `auth` with action `set-api-key` and the key to authenticate -- the key is validated and stored in the MCP session automatically. All subsequent tool calls use it. By default, API keys have the same permissions as the account owner. Keys can optionally be **scoped** to specific organizations, workspaces, or shares (using the same scope system as OAuth tokens) -- scoped keys can only access the granted entities, and operations outside the scope return 403. Keys can also be tagged with an `agent_name` for tracking and given an expiration date. Unscoped keys do not expire unless revoked. Agents can also manage API keys programmatically with `auth` actions `api-key-create`, `api-key-update`, `api-key-list`, `api-key-get`, and `api-key-delete`. **Option 3: Agent Account Invited to a Human's Org** If you want your own agent identity but need to work within a human's existing organization, create an agent account with `auth` action `signup`, then have the human invite you to their org with `member` action `add` (entity_type `org`) or to a workspace with `member` action `add` (entity_type `workspace`). Alternatively the human can invite via the UI: Settings -> Your Organization -> Manage People. This gives you access to their workspaces and shares while keeping your own account separate. After accepting invitations with `user` action `accept-all-invitations`, use `auth` action `signin` to authenticate normally. **Note:** If the human only invites you to a workspace (not the org), the org will appear as external -- see **Internal vs External Orgs** in the Organizations section. **Option 4: Browser Login (PKCE)** **Not for headless agents:** PKCE requires a human with a browser present in the conversation. Headless agents, CLI tools, and automated pipelines cannot complete this flow — use Option 1 (signup) or Option 2 (API key) instead. If you prefer not to send a password through the agent, use browser-based PKCE login. Call `auth` action `pkce-login` (optionally with an `email` hint) to get a login URL. The user opens the URL in a browser, signs in (email/password or SSO like Google/Microsoft), and approves access. The browser displays an authorization code which the user copies back to the agent. Call `auth` action `pkce-complete` with the code to finish signing in. This is the most secure option -- no credentials pass through the agent. PKCE login supports optional **scoped access** via the `scope_type` parameter. By default, `scope_type` is `"user"` (full account access). Other scope types restrict the token to specific entity types: | scope_type | Access granted | |------------|---------------| | `user` | Full account access (default) | | `org` | User selects specific organizations | | `workspace` | User selects specific workspaces | | `all_orgs` | All organizations the user belongs to | | `all_workspaces` | All workspaces the user has access to | | `all_shares` | All shares the user is a member of (`share:*:`) | **Scope inheritance:** Broader scopes include access to child entities automatically: - `all_orgs` includes all orgs + all workspaces + all shares within those orgs - `all_workspaces` includes all workspaces + all shares within those workspaces - `org` scope on a specific org includes access to all workspaces and shares within that org - `workspace` scope on a specific workspace includes access to shares within that workspace - `all_shares` grants direct access to all shares the user has membership in, bypassing workspace/org inheritance The `agent_name` parameter controls what the user sees on the approval screen -- the screen displays "**[agent_name]** will act on your behalf". If omitted, only the client name is shown. Use a descriptive name so the user knows which agent is requesting access. **Approval flow by scope_type:** - **`user`** (default): Full account access. The user sees a simple approve/decline prompt with no entity picker. - **`org`**, **`workspace`**: The user sees an entity selection screen listing their accessible entities with checkboxes, plus a read-only / read-write toggle. The user picks which entities to grant, then approves or declines. - **`all_orgs`**, **`all_workspaces`**, **`all_shares`**: The user sees a summary of the wildcard access being requested (no entity picker), then approves or declines. The MCP server defaults to `scope_type="user"` for backward compatibility. | Scenario | Recommended Approach | |----------|---------------------| | Operating autonomously, storing files, building for users | Create an agent account with your own org (Option 1) | | Helping a human manage their existing account | Ask the human to create an API key for you (Option 2) | | Working within a human's org with your own identity | Create an agent account, have the human invite you (Option 3) | | Building something to hand off to a human | Create an agent account, build it, then transfer the org (Option 1) | | Signing in without sending a password through the agent | Browser-based PKCE login (Option 4) | | Running headless / no browser available | Create an agent account (Option 1) or use an API key (Option 2) — do NOT use PKCE | **Credit limits by account type:** Agent accounts (Options 1, 3) can transfer orgs to humans when credits run out -- see Ownership Transfer in section 3. Human accounts (Option 2) cannot use the transfer/claim API; direct the human to upgrade their plan at `https://go.fast.io/settings/billing` or via `org` action `billing-create`. ### Standard Sign-In Flow 1. Call `auth` with action `signin`, `email` and `password`. 2. The server returns a JWT `auth_token` and stores it in the session automatically. 3. All subsequent tool calls use this token without any manual passing. ### Agent Account Creation When creating a new account (Options 1 and 3 above), agents **MUST** use `auth` action `signup` which automatically registers with `agent=true`. Never sign up as a human account. Agent accounts provide: - `account_type` set to `"agent"` - Free agent plan assigned automatically - Transfer/claim workflow enabled for handing orgs off to humans **Steps:** 1. (Optional) `auth` action `email-check` -- advisory hint only; do NOT gate on the result. Always attempt `signup`; see Section 9 for why. 2. Call `auth` action `signup` with `first_name`, `last_name`, `email`, and `password`. The `agent=true` flag is sent automatically by the MCP server. 3. The account is created and a session is established automatically -- the agent is signed in immediately. 4. **Verify your email** (required before using most endpoints): Call `auth` action `email-verify` with `email` to send a verification code, then call `auth` action `email-verify` again with `email` and `email_token` to validate the code. 5. No credit card is required. No trial period. No expiration. The account persists indefinitely. ### Two-Factor Authentication Flow 1. Call `auth` action `signin` with `email` and `password`. 2. If the response includes `two_factor_required: true`, the returned token has limited scope. 3. Call `auth` action `2fa-verify` with the 2FA `code` (TOTP, SMS, or WhatsApp). 4. The server replaces the limited-scope token with a full-scope token automatically. ### Inline 2FA for Sensitive Operations Some API endpoints require per-request 2FA verification when the account has 2FA enabled. These operations require a valid 2FA `token` parameter (6-digit TOTP or SMS/call/WhatsApp code) in addition to normal authentication: - **`api-key-create`** — creating a new API key - **`api-key-delete`** — revoking an API key If the account does not have 2FA enabled, these operations work normally without a token. If 2FA is enabled and the token is missing or invalid, the request fails. **Workflow:** 1. Check 2FA status: `auth` action `2fa-status` — if `state` is `"enabled"`, inline 2FA is required. 2. Prompt the user for a TOTP code from their authenticator app, or send a code via `auth` action `2fa-send`. 3. Pass the code as the `token` parameter to `api-key-create` or `api-key-delete`. **Tip:** API key authentication (`auth` action `set-api-key`) bypasses inline 2FA checks entirely. If the agent is already authenticated via API key, no token is needed for these operations. ### Browser Login (PKCE) Flow 1. Call `auth` action `pkce-login` (optionally with `email` to pre-fill the sign-in form, `scope_type` to request scoped access, and `agent_name` to identify the agent). 2. The tool returns a `login_url` -- present it to the user to open in a browser. 3. The user signs in (email/password or SSO). 4. The user sees the approval screen showing the `agent_name` (or client name if not provided). Depending on `scope_type`: for `user` they simply approve; for `org`/`workspace` they select specific entities and read-only/read-write access; for `all_orgs`/`all_workspaces`/`all_shares` they review the wildcard access summary. 5. The user clicks Approve. The browser displays an authorization code. The user copies it. 6. Call `auth` action `pkce-complete` with the `code` to exchange it for an access token. 7. The session is established automatically -- all subsequent tool calls are authenticated. If scoped access was granted, `scopes` and `agent_name` are included in the response and stored in the session. ### Checking Session Status - `auth` action `status` -- checks the local Durable Object session. No API call is made. Returns authentication state, user ID, email, auth_method, token expiry, scopes, and agent_name. If the session has expired, returns `session_expired: true` with `expired_reason` (`"token_expired"` or `"refresh_expired"`) and `expired_at` timestamp. - `auth` action `check` -- validates the token against the Fast.io API. Returns the user ID if the token is still valid. ### Session Expiry and Auto-Refresh **OAuth/PKCE sessions** (the default) have 1-hour access tokens and 30-day refresh tokens. The MCP server **proactively refreshes** OAuth access tokens before they expire -- an internal alarm fires ~5 minutes before expiry and silently obtains a new token using the stored refresh token. This creates a self-sustaining cycle: sessions stay alive indefinitely without user interaction, until the 30-day refresh token chain expires or is revoked. If proactive refresh fails, a reactive safety net retries on the next tool call (401 → refresh → retry). **Basic JWT sessions** (from `auth` action `signin`) last 30 days and have no refresh token. When the token expires, the session is cleaned up and re-authentication is required. **API keys** do not expire by default, but can optionally have an expiration set via `api-key-create` or `api-key-update` with the `key_expires` parameter. API key expiration is enforced server-side by the backend. The MCP server tracks how each session was authenticated (`auth_method`: `"api_key"`, `"jwt"`, or `"oauth"`) and skips client-side expiration checks for API key sessions. **Error differentiation:** When a session expires, tool calls return `"Session expired. Please re-authenticate..."` -- distinct from `"Not authenticated..."` which indicates no prior session existed. This helps distinguish reconnection issues from first-time setup. ### Signing Out Call `auth` action `signout` to clear the stored session from the Durable Object. --- ## 3. Core Concepts ### Organizations Organizations are top-level containers that collect workspaces. An organization can represent a company, a business unit, a team, or simply your own personal collection. Every user belongs to one or more organizations. Organizations have: - **Workspaces** — the file storage containers that belong to the organization. - **Members** with roles: owner, admin, member, guest, view. - **Billing and subscriptions** managed through Stripe integration. - **Plan limits** that govern storage, transfer, AI tokens, and member counts. Organizations are identified by a 19-digit numeric profile ID or a domain string. **IMPORTANT:** When creating orgs, agents MUST use `org` action `create` which automatically assigns `billing_plan: "agent"`. This ensures the org gets the free agent plan (50 GB, 5,000 credits/month). Do not use any other billing plan for agent-created organizations. #### Custom Domains Organizations on Pro or Business plans can configure a custom domain (e.g. `files.acme.com`) that serves the org's content. One custom domain per org. **Setup flow:** 1. `org` action `custom-domain-create` with `org_id` and `hostname` (a valid FQDN, e.g. `files.acme.com`). Returns `hostname`, `status: "pending"`, and `cname_target`. 2. The customer adds a DNS CNAME record: `files.acme.com CNAME custom.fast.io` (production) or `custom.fastdev1.com` (dev). 3. On the first request through the CNAME, a TLS certificate is automatically provisioned via Let's Encrypt (2-5 seconds). The domain status changes from `pending` to `active`. **Checking status:** `org` action `custom-domain-get` with `org_id`. Returns the domain info or `{ hostname: null }` if no custom domain is configured. **Validating DNS:** `org` action `custom-domain-validate` with `org_id`. Performs a live DNS lookup and returns whether the CNAME is correct. If valid and status is pending, the domain is automatically activated. **Removing:** `org` action `custom-domain-delete` with `org_id`. The existing TLS certificate expires naturally (up to 90 days); there is no immediate effect on traffic. No plan gate -- orgs that downgrade can still remove their domain. **Plan requirement:** Custom domains require a Pro or Business plan for creation. The agent plan does not include this feature. If the org is on a plan that does not support custom domains, creation returns a subscription upgrade error. #### Org Discovery (IMPORTANT) To discover all available orgs, agents **must call both actions**: 1. `org` action `list` -- returns internal orgs where you are a direct member (`member: true`) 2. `org` action `discover-external` -- returns external orgs you access via workspace membership only (`member: false`) **An agent that only checks `org` action `list` will miss external orgs entirely and won't discover the workspaces it's been invited to.** External orgs are the most common pattern when a human invites an agent to help with a specific project -- they add the agent to a workspace but not to the org itself. #### Internal vs External Orgs **Internal orgs** (`member: true`) -- orgs you created or were invited to join as a member. You have org-level access: you can see all workspaces (subject to permissions), manage settings if you're an admin, and appear in the org's member list. **External orgs** (`member: false`) -- orgs you can access only through workspace membership. You can see the org's name and basic public info, but you cannot manage org settings, see other workspaces, or add members at the org level. Your access is limited to the specific workspaces you were explicitly invited to. **Example:** A human invites your agent to their "Q4 Reports" workspace. You can upload files, run AI queries, and collaborate in that workspace. But you cannot create new workspaces in their org, view their billing, or access their other workspaces. The org shows up via `org` action `discover-external` -- not `org` action `list`. If the human later invites you to the org itself, the org moves from external to internal. ### Workspaces Workspaces are file storage containers within organizations. Each workspace has: - Its own set of **members** with roles (owner, admin, member, guest). Members have a `status` of `active` or `pending`. Pending members are invited users who haven't signed up yet — they appear in member lists immediately and can be assigned tasks, approvals, and todos. Notifications for pending members are suppressed until they sign up. When they sign up, their status becomes `active` and all assignments are preserved. - A **storage tree** of files and folders (storage nodes). - Optional **AI features** for RAG-powered chat. - **Shares** that can be created within the workspace. - **Archive/unarchive** lifecycle management. - **50 GB included storage** on the free agent plan, with files up to 1 GB per upload. - **File versioning** -- every edit creates a new version, old versions are recoverable. - **Keyword and semantic search** -- find files by name or content; with intelligence enabled, search by meaning. Workspaces are identified by a 19-digit numeric profile ID. #### Intelligence: On or Off Workspaces have an **intelligence** toggle that controls whether AI features are active. > **⚠️ COST WARNING:** Intelligence incurs significant ingestion costs (10 credits per page for every uploaded document). For a workspace with hundreds or thousands of pages, this adds up quickly. **Do NOT enable intelligence unless the user specifically needs RAG chat queries or semantic search via storage search.** Most workflows (file storage, sharing, collaboration, one-off file analysis) work perfectly without it. **Intelligence OFF (recommended default)** -- the workspace is pure file storage. You can still attach files directly to an AI chat conversation (up to 20 files, 200 MB total) and ask questions about them -- no ingestion cost. This is the right choice for most use cases: file storage, sharing, collaboration, project coordination, and analyzing a small number of specific files. **Intelligence ON (only when needed)** -- the workspace becomes an AI-powered knowledge base. Every document and code file uploaded is automatically ingested, summarized, and indexed. **Only enable this when the user needs one of these two capabilities:** 1. **RAG queries across many documents** -- scope AI chat to entire folders or the full workspace and ask questions across all indexed content. The AI retrieves relevant passages and answers with citations. This is useful when you have a large volume of documents and need to search across all of them. 2. **Semantic search via storage search** -- find files by meaning, not just keywords. Use `storage` action `search` to find documents semantically. "Show me contracts with indemnity clauses" works even if those exact words do not appear in the filename. Intelligence also enables auto-summarization and automatic metadata extraction, but these alone do not justify the ingestion cost. > **Coming soon:** RAG indexing support for images, video, and audio files. Currently only documents and code are indexed. **Default behavior:** The MCP server defaults intelligence to OFF when creating workspaces and shares. To enable intelligence, you must explicitly pass `intelligence: "true"`. **Do NOT enable intelligence unless the user specifically requests RAG chat queries or semantic search via storage search.** Do not enable it speculatively "just in case" -- it can always be enabled later, but ingestion costs (10 credits/page) are incurred immediately and are non-refundable. **Agent use case:** Create a workspace per project or client. Keep intelligence OFF for storage and collaboration. Only enable it when users need to query across a large document set. Upload reports, datasets, and deliverables. Invite other agents and human stakeholders. Everything is organized, searchable, and versioned. For full details on AI chat types, file context modes, AI state, and how intelligence affects them, see the **AI Chat** section below. ### Shares Shares are purpose-built spaces for exchanging files with people outside your workspace. They can exist within workspaces and have three types: | Mode | What It Does | Agent Use Case | |------|-------------|----------------| | **Send** | Recipients can download files | Deliver reports, exports, generated content | | **Receive** | Recipients can upload files | Collect documents, datasets, user submissions | | **Exchange** | Both upload and download | Collaborative workflows, review cycles | #### Portals A **Portal** is a Send share created from a workspace folder (`storage_mode=workspace_folder`). Portals are always Send-only -- recipients can view and download files but cannot upload. The portal displays the live contents of the linked workspace folder, so any changes to the folder are immediately reflected. Portals are ideal for publishing a folder's contents externally (e.g., a client deliverables folder) without duplicating files. To create a portal: use `share` action `create` with `share_type: "send"`, `storage_mode: "workspace_folder"`, and `folder_node_id` (or `create_folder: true`). #### Share Features - **Password protection** -- require a password for link access - **Expiration dates** -- shares auto-expire after a set period - **Download controls** -- three security levels: `off` (no restrictions, default), `medium` (guests can preview files inline but cannot download), `high` (all guest downloads blocked). Set via `download_security` on create/update. - **Access levels** -- Members Only, Org Members, Registered Users, or Public (anyone with the link) - **Custom branding** -- background images, gradient colors, accent colors, logos - **Post-download messaging** -- show custom messages and links after download - **Up to 3 custom links** per share for context or calls-to-action - **Anonymous file drops** -- allow guests to upload files to Receive/Exchange shares without registration (enable `anonymous_uploads_enabled` with "Anyone" access) - **Guest chat** -- let share recipients ask questions in real-time - **AI-powered auto-titling** -- shares automatically generate smart titles from their contents - **Activity notifications** -- get notified when files are sent or received - **Comment controls** -- configure who can see and post comments (owners, guests, or both) #### Two Storage Modes When creating a share with `share` action `create`, the `storage_mode` parameter determines how files are stored: - **`independent`** (independent storage, default) -- The share has its own isolated storage. Files are added directly to the share and are independent of any workspace. This creates a self-contained share -- changes to workspace files do not affect the share, and vice versa. Use for final deliverables, compliance packages, archived reports, or any scenario where you want an immutable snapshot. - **`workspace_folder`** (workspace-backed) -- The share is backed by a specific folder in a workspace. The share displays the live contents of that folder -- any files added, updated, or removed in the workspace folder are immediately reflected in the share. No file duplication, so no extra storage cost. To create a workspace folder share, pass `storage_mode=workspace_folder` and `folder_node_id={folder_opaque_id}` when creating the share. **Note:** Expiration dates are not allowed on workspace folder shares since the content is live. **Note:** Intelligence is not supported on workspace folder shares -- `intelligence` is always set to `false` regardless of the value passed. To use AI features on these files, use the parent workspace's AI endpoints instead. Both modes look the same to share recipients -- a branded share with file preview, download controls, and all share features. The difference is whether the content is a snapshot (independent) or a live view (workspace folder). **Response fields:** API responses include both `storage_mode` (`independent` or `workspace_folder`) and `share_category` (`portal` or `shared_folder`). Use `storage_mode` when creating shares; `share_category` is a read-only classification in responses. Shares are identified by a 19-digit numeric profile ID. **Agent use case:** Generate a quarterly report, create a Send share with your client's branding, set a 30-day expiration, and share the link. The client sees a professional, branded page with instant file preview -- not a raw download link. ### Storage Nodes Files and folders are represented as storage nodes. Each node has an opaque ID (a 30-character alphanumeric string, displayed with hyphens, e.g. `f3jm5-zqzfx-pxdr2-dx8z5-bvnb3-rpjfm4`). The special value `root` refers to the root folder of a workspace or share, and `trash` refers to the trash folder. Key operations on storage nodes: list, create-folder, move, copy, rename, delete (moves to trash), purge (permanently deletes), restore (recovers from trash), search, add-file (link an upload), and add-link (create a share reference). Nodes have versions. Each file modification creates a new version. Version history can be listed and files can be restored to previous versions. #### Overwriting files (REPLACE by default, versioned in place) **Do NOT delete and re-upload to "update" a file.** Same-name uploads to the same parent folder **overwrite the existing node in place, preserving the `node_id`**. The prior content is kept as a version and is recoverable at any time. Deleting the old node first is wasted work, breaks any `node_id` references held by other entities (comments, tasks, approvals, metadata, links), and can leak the file into trash — it is never the right pattern for editing a file's bytes. **The correct update-a-file pattern:** 1. `upload` action `create-session` with the **same** `parent_node_id` and the **same** `filename` as the existing file (plus `profile_type`, `profile_id`, `filesize`). The server resolves the collision to the existing node. 2. `POST /blob` with the new bytes (see Upload section below). 3. `upload` action `chunk` with `blob_id`, then `upload` action `finalize` (or use `stream` mode for single-shot streamed uploads). 4. The `node_id` is unchanged. The previous content becomes a version entry. 5. Inspect history with `storage` action `version-list` (returns all versions for the node). Roll back to any earlier version with `storage` action `version-restore`. Deterministic overwrite by node_id: if the filename may have drifted (e.g., a previous rename), or you want to guarantee the overwrite hits a specific `node_id` without re-resolving the parent folder, pass `target_node_id` on `create-session`. This pins the update target explicitly — the server uses `action=update` + `file_id=`; `parent_node_id` is ignored and `filename` is optional (omit to keep the current name, or pass a new one to rename-on-replace). When `filename` is omitted, the tool performs one extra `storage` `details` lookup to fetch the current name (the Fast.io API still requires `name` in update mode); pass `filename` explicitly if you want to skip that call. See the `target_node_id` documentation in the Upload section below. **Worked example — edit a file's content and recover the prior version:** ``` # Initial upload upload create-session profile_type=workspace, profile_id=, parent_node_id=, filename="state.json", filesize=1024 POST /blob upload chunk upload_id= chunk_number=1 blob_id= upload finalize upload_id= # → new_file_id = f3jm5-zqzfx-... (this is the stable node_id) # Later, "edit" the file by re-uploading with the same name+parent upload create-session profile_type=workspace, profile_id=, parent_node_id=, filename="state.json", filesize=2048 POST /blob upload chunk upload_id= chunk_number=1 blob_id= upload finalize upload_id= # → new_file_id = f3jm5-zqzfx-... (SAME node_id — overwritten in place) # Inspect version history storage version-list profile_type=workspace profile_id= node_id=f3jm5-zqzfx-... # → [{version_id: v2, current: true}, {version_id: v1, ...}] # Roll back if needed storage version-restore profile_type=workspace profile_id= node_id=f3jm5-zqzfx-... version_id=v1 ``` **What overwriting covers (REPLACE is the default behavior for all name collisions):** - **Upload (addfile)** -- silently overwrites the existing file. The previous content is preserved as a version entry, recoverable via `storage` action `version-list` / `version-restore`. Node ID is stable. - **Move / Copy** -- trashes the existing conflicting file, then completes the operation. The old file is recoverable from trash. - **Restore from trash** -- trashes the existing conflicting file, then restores. - **Folder conflicts and type mismatches** (file vs folder) still fall back to rename (e.g. `folder (2)`). Uploading a file with the same name as an existing file will **overwrite it**, not create a renamed copy like `report (2).pdf`. If you specifically need multiple files with the same name to coexist, rename them before uploading. ### Notes Notes are a storage node type (alongside files and folders) that store markdown content directly on the server. They live in the same folder hierarchy as files, are versioned like any other node, and appear in storage listings with `type: "note"`. #### Creating and Updating Notes Create notes with `workspace` action `create-note`, read with `workspace` action `read-note`, and update with `workspace` action `update-note`. > **Files and Notes are not interchangeable, even when both hold markdown.** A `.md` uploaded via the file-upload flow is a **File** (`type: "file"`), not a **Note** (`type: "note"`). Reading a markdown File returns text and "looks like" a note, but note-specific APIs (`update-note`, `read-note`) reject it with `Node is not a note` (error 153548). Choose the right creation path up front: > > - **If you will edit the content incrementally from an agent** → use `create-note`. Pass markdown as `content` directly. Do NOT upload it as a file first. > - **If it is a static artifact** (report, export, attachment) → use the upload flow. Accept that `update-note` will not work later; to change the content, upload a new version by calling `upload` action `create-session` with the **same** `parent_node_id` and **same** `filename` as the existing File, then `chunk`/`finalize` (or `stream`). Same-name uploads overwrite the File in place and preserve the previous content as a version (recover via `storage` action `version-list` / `version-restore`). > > When `update-note` fails with `Node is not a note`, the node is almost always a File. You have two valid recovery paths — pick based on what the node should be going forward: > > - **(a) Keep it as a File** and just change its bytes → use the upload flow described above (same `parent_node_id` + `filename` = in-place overwrite with a version entry). The node ID does NOT change; the node stays a File. > - **(b) Convert to a Note** (because you want to edit it incrementally via `update-note` from now on) → delete the File via `storage` action `delete`, then call `create-note` with the markdown content in the desired `parent_id`. This produces a NEW node with `type: "note"`. Future edits use `update-note` with the new `node_id`. > > Do NOT use delete-and-re-upload (via the upload flow) as a fix — that just creates another File and you will hit the same `Node is not a note` error on the next `update-note` call. To verify a node's type before calling, use `storage` action `details` and inspect the `type` field (`"file"` vs `"note"` vs `"folder"` vs `"link"`). **Creating:** Provide `workspace_id`, `parent_id` (folder opaque ID or `"root"`), `name` (must end in `.md`, max 100 characters), and exactly one of `content` (inline markdown, max 100 KB) or `blob_id` (see below). **Reading:** Provide `workspace_id` and `node_id`. Returns the note's markdown content and metadata. **Updating:** Provide `workspace_id`, `node_id`, and at least one of `name` (must end in `.md`), `content` (max 100 KB), or `blob_id`. When `content` and `blob_id` are both passed, the call errors — provide exactly one. #### Passing note content via `blob_id` (preferred for large notes) Both `create-note` and `update-note` accept an optional `blob_id` as an alternative to inline `content`: > `blob_id`: optional string. Blob ID from `POST /blob` response. Recommended for large note content — avoids base64 overhead and MCP transport limits. Consumed after use. Bytes are decoded as UTF-8 and passed as note content. (used by: `create-note`, `update-note` as one of `content`/`blob_id`) **Why this exists.** MCP transports tool parameters as inline JSON strings over the JSON-RPC pipe. Sending more than a few KB of note content through the `content` parameter is measurably slow — the full string has to be serialized into the tool call, travel through the transport, and be parsed again on the server. The `POST /blob` sidecar is a separate raw-HTTP path that bypasses MCP transport entirely: you POST the raw bytes (up to 100 MB, single-use, 5-minute TTL), get back a `blob_id`, and hand the `blob_id` to the tool. The server consumes the blob, UTF-8 decodes it, sanitizes it, and uses it as note content. Same pattern as `upload` action `chunk`/`stream`. **When to use which:** | Note size | Recommended path | |---|---| | Small edits (< ~10 KB — a few paragraphs, bullets, small sections) | Inline `content` | | Large notes (> ~10 KB — rich project context, transcripts, long markdown documents) | `POST /blob` → `blob_id` | Notes are capped at **100 KB** per node. Writes at or above **80 KB** return a non-fatal warning in `_warnings` (or via `withHints` on `create-note`) recommending rollover before you hit the ceiling. The warning is advisory — the write still succeeds. A typical rollover pattern is dated archive files: when a growing note crosses ~80 KB, create a new note named something like `archive-2026-04-14.md` or `notes-2026-W15.md`, move the older material there, and keep the "live" note small. | Constraint | Limit | |------------|-------| | Content encoding | Valid UTF-8 (UTF8MB4). Invalid byte sequences and control characters (`\p{C}` except `\t`, `\n`, `\r`) are stripped. | | Content size | 100 KB max | | Filename | 1-100 characters, must end in `.md` | | Markdown validation | Code blocks and emphasis markers must be balanced | | Rate limit | 2 per 10s, 5 per 60s | #### Notes as Long-Term Knowledge Grounding In an intelligent workspace, notes are automatically ingested and indexed just like uploaded documents. This makes notes a way to bank knowledge over time -- any facts, context, or decisions stored in notes become grounding material for future AI queries. When an AI chat uses folder scope (or defaults to the entire workspace), notes within that scope are searched alongside files. The AI retrieves relevant passages from notes and cites them in answers. Key behaviors: - Notes are ingested for RAG when workspace intelligence is enabled - Notes within a folder scope are included in scoped queries - Notes with `ai_state: indexed` are searchable via RAG - Notes can also be attached directly to a chat via `files_attach` (check `ai.attach` is `true` in storage details) **Use cases:** - Store project context, decisions, and rationale. Months later, ask "Why did we choose vendor X?" and the AI retrieves the note. - Save research findings in a note. Future AI chats automatically use those findings as grounding. - Create reference documents (style guides, naming conventions) that inform all future AI queries in the workspace. #### Other Note Operations Notes support the same storage operations as files and folders: move (via `storage` action `move`), copy (`storage` action `copy`), delete/trash (`storage` action `delete`), restore (`storage` action `restore`), version history (`storage` action `version-list`), and details (`storage` action `details`). #### Linking Users to Notes - **Note in workspace context** (opens workspace with note panel): `https://{domain}.fast.io/workspace/{folder_name}/storage/root?note={note_id}` - **Note preview** (standalone view): `https://{domain}.fast.io/workspace/{folder_name}/preview/{note_id}` ### AI Chat AI chat lets agents ask questions about files stored in workspaces and shares. Two chat types are available, each with different file context options. **AI chat is read-only.** It can read, analyze, search, and answer questions about file contents, but it cannot modify files, change workspace settings, manage members, or access events. Any action beyond reading file content — uploading, deleting, moving files, changing settings, managing shares, reading events — must be done through the MCP tools directly. Do not attempt to use AI chat as a general-purpose tool for workspace management. #### Two Chat Types - **`chat`** — Basic AI conversation with no file context from the workspace index. Use for general questions only. - **`chat_with_files`** — AI grounded in your files. Two mutually exclusive modes for providing file context: **Auto-promotion:** If you create a chat with `type=chat` but include `files_scope`, `folders_scope`, or `files_attach`, the system automatically promotes the type to `chat_with_files`. You don't need to worry about setting the type exactly right — the intent is unambiguous when file parameters are present. - **Folder/file scope (RAG)** — limits the retrieval search space. Requires intelligence enabled; files must be in `indexed` AI state. - **File attachments** — files read directly by the AI. No intelligence required; files must have `ai.attach: true` in storage details (the file must be a supported type for AI analysis). Max 20 files, 200 MB total. Both types augment answers with web knowledge when relevant. #### File Context: Scope vs Attachments For `chat_with_files`, choose one of these mutually exclusive approaches: | Feature | Folder/File Scope (RAG) | File Attachments | |---------|------------------------|------------------| | How it works | Limits RAG search space | Files read directly by AI | | Requires intelligence | Yes | No | | File readiness requirement | `ai_state: indexed` | `ai.attach: true` | | Best for | Many files, knowledge retrieval | Specific files, direct analysis | | Max references | 100 folder refs (subfolder tree expansion) or 100 file refs | 20 files / 200 MB | | Default (no scope given) | Entire workspace | N/A | **Scope parameters** (REQUIRES intelligence — will error if intelligence is off): - `folders_scope` — comma-separated `nodeId:depth` pairs (depth 1-10, max 100 subfolder refs). Defines a search boundary — the RAG backend finds documents within scoped folders automatically. Just pass folder IDs with depth; do not enumerate individual files. A folder with thousands of files and few subfolders works fine. - `files_scope` — comma-separated `nodeId:versionId` pairs (max 100). Limits RAG to specific indexed files. nodeId is required; versionId is required in the pair format but will be **auto-resolved to the node's current version** if left empty (e.g., `nodeId:` with nothing after the colon). Get `versionId` from the file's `version` field via `storage` action `details` (returned by default at `detail: "full"`); on `storage` action `list`, `version` is omitted at the default `detail: "terse"` — pass `detail: "standard"` or higher to surface it inline. - **If neither is specified, the default scope is the entire workspace (all indexed documents).** This is the recommended default — omit scope parameters unless you specifically need to narrow the search. **Attachment parameter** (no intelligence required): - `files_attach` — comma-separated `nodeId:versionId` pairs (max 20, 200 MB total). nodeId is required; versionId will be **auto-resolved to the current version** if left empty. Files are read directly, not via RAG. **FILES ONLY: passing a folder nodeId returns a 406 error.** To include folder contents in AI context, use `folders_scope` instead (requires intelligence). **Only files with `ai.attach: true` in storage details can be attached** — check before using. **Do not** list folder contents and pass individual file IDs as `files_scope` when you mean to search a folder — use `folders_scope` with the folder's nodeId instead. `files_scope` is only for targeting specific known file versions. **Scope vs attach:** `files_scope` and `folders_scope` narrow the RAG search boundary and **require workspace intelligence to be enabled** — they will error on non-intelligent workspaces. `files_attach` sends files directly to the AI without indexing and works regardless of intelligence setting, but accepts only file nodeIds (not folders). `files_scope`/`folders_scope` and `files_attach` are mutually exclusive — sending both will error. **Citations behavior:** the response `citations` array is populated only in RAG modes (`files_scope` / `folders_scope`) — when the AI selects passages from a corpus and cites which it used. In `files_attach` mode the file is force-attached, so `citations` is always an empty array; the answer text itself is the only source attribution. #### Intelligence and AI State The workspace intelligence toggle (see Workspaces above) controls whether uploaded documents and code files are auto-ingested, summarized, and indexed for RAG. Each file has an `ai_state` indicating its readiness: | State | Meaning | |-------|---------| | `disabled` | No AI processing done (file type not supported, or AI completely off) | | `pending` | Queued for AI processing | | `in_progress` | Currently being processed | | `ready` | Summary exists, file is attachable for AI chat, but NOT vector-indexed (intelligence OFF) | | `indexed` | Summary + vector indexed — file is searchable via RAG/semantic search (intelligence ON) | | `failed` | Processing failed | Only files with `ai_state: indexed` are included in folder/file scope (RAG) searches. Files with `ai_state: ready` or `indexed` are both attachable for AI chat — check the `ai.attach` field. Check file state via `storage` action `details` with `profile_type: "workspace"`. When polling for AI processing completion: if intelligence is ON, wait for `indexed`; if intelligence is OFF (but AI summaries are enabled), wait for `ready`. Check `capabilities.can_use_intelligence` on the workspace to know which terminal state to expect. #### Attachability — the `ai.attach` Flag File nodes returned by `storage` action `details` (default `detail: "full"`) include an `ai` object with three fields. The `ai.attach` flag specifically requires `detail: "full"` — list/recent/search at the default `detail: "terse"` omit the `ai` object entirely, and `standard` exposes only `ai.state` (not `ai.attach`). Always preflight via `storage` action `details` (full by default) before calling `files_attach`. | Field | Type | Meaning | |-------|------|---------| | `ai.state` | string | AI processing state (`disabled`, `pending`, `inprogress`, `ready`, `indexed`, `failed`) | | `ai.attach` | boolean | Whether the file can be used with `files_attach` | | `ai.summary` | boolean | Whether the file already has an AI-generated summary | **Before using `files_attach`, check that `ai.attach` is `true`.** A file is attachable when its type supports AI analysis (documents, code, images, PDFs, spreadsheets, etc.) or when it already has a summary from prior processing. Files with `ai.attach: false` (unsupported formats, corrupt files, or files still processing) will be rejected by the API. This flag is independent of the workspace intelligence setting — a file can have `ai.attach: true` even when intelligence is off. **When to enable intelligence:** You need RAG chat queries across many documents (scoped to folders or the full workspace) or semantic search via `storage` action `search`. Do NOT enable just for auto-summarization or metadata extraction alone -- the ingestion cost (10 credits/page) is significant. **When to disable intelligence (recommended default):** The workspace is for storage, sharing, collaboration, or you only need to analyze specific files via attachments. This covers most use cases. Saves significant credits. Intelligence can always be enabled later if needed. Even with intelligence off, `chat_with_files` with file attachments still works for files with `ai.attach: true`. #### How to Phrase Questions **With folder/file scope (RAG):** Write questions likely to match content in indexed files. The AI searches the scope, retrieves passages, and cites them. - Good: "What are the payment terms in the vendor contracts?" - Good: "Summarize the key findings from the Q3 analysis reports" - Bad: "Tell me about these files" — too vague, no specific content to match - Bad: "What's in this workspace?" — cannot meaningfully search for "everything" **With file attachments:** Be direct — the AI reads the full file content. No retrieval step. - "Describe this image in detail" - "Extract all dates and amounts from this invoice" - "Convert this CSV data into a summary table" **Personality:** The `personality` parameter controls the tone and length of AI responses. Pass it when creating a chat or sending a message: - `concise` — short, brief answers - `detailed` — comprehensive answers with context and evidence (default) Use `concise` when you need a quick fact, a yes/no answer, or a brief summary. Use `detailed` (or omit the parameter) when you need thorough analysis with supporting evidence and citations. The personality can also be overridden per follow-up message. **Controlling verbosity in questions:** You can also guide verbosity through how you phrase the question itself: - "In one sentence, what is the main conclusion of this report?" - "List only the file names that mention GDPR compliance, no explanations" - "Give me a brief summary — 2-3 bullet points max" Combining `personality: "concise"` with a direct question produces the shortest answers and uses the fewest AI credits. #### Chat Parameters Create a chat with `ai` action `chat-create` (with `profile_type: "workspace"`) or `ai` action `chat-create` (with `profile_type: "share"`): - `type` (required) — `chat` or `chat_with_files` - `query_text` (required for workspace, optional for share) — initial message, 2-12,768 characters - `personality` (optional) — `concise` or `detailed` (default: `detailed`) - `privacy` (optional) — `private` or `public` (default: `public`) - `files_scope` (optional) — `nodeId:versionId,...` (max 100, requires `chat_with_files` + intelligence). nodeId required; versionId auto-resolved if empty. **Omit to search all indexed documents (recommended default).** - `folders_scope` (optional) — `nodeId:depth,...` (depth 1-10, max 100 subfolder refs, requires `chat_with_files` + intelligence). Folder scope = search boundary, not file enumeration. **Omit to search all indexed documents (recommended default).** - `files_attach` (optional) — `nodeId:versionId,...` (max 20 / 200 MB, nodeId required, versionId auto-resolved if empty, mutually exclusive with scope params) #### Follow-up Messages Send follow-ups with `ai` action `message-send` (with `profile_type: "workspace"` or `"share"`). The chat type is inherited from the parent chat. Each follow-up can update the scope, attachment, and personality parameters. #### Waiting for AI Responses After creating a chat or sending a message, the AI response is asynchronous. Message states progress: `ready` → `in_progress` → `complete` (or `errored`). **Recommended:** Call `ai` action `message-read` (with `profile_type: "workspace"` or `"share"`) with the returned `message_id`. The tool polls automatically (up to 15 attempts, 2-second intervals, ~30 seconds). If the response is still processing after that window, use `event` action `activity-poll` with the workspace/share ID instead of calling the read action in a loop — see Activity Polling in section 7. #### Response Citations Completed AI responses include citations pointing to source files: - `nodeId` — storage node opaque ID - `versionId` — file version opaque ID - `entries[].page` — page number - `entries[].snippet` — text excerpt - `entries[].timestamp` — audio/video timestamp #### Linking Users to AI Chats Append `?chat={chat_opaque_id}` to the workspace storage URL: `https://{domain}.fast.io/workspace/{folder_name}/storage/root?chat={chat_id}` #### Share AI Chats Shares support AI chat with identical capabilities. All workspace AI endpoints have share equivalents accessible via `ai` actions with `profile_type: "share"`. ### AI Share / Export Generate temporary markdown-formatted download URLs for files that can be pasted into external AI tools (ChatGPT, Claude, etc.). Use `ai` action `share-generate` (with `profile_type: "workspace"` or `"share"`). URLs expire after 5 minutes. Limits: 25 files maximum, 50 MB per file, 100 MB total. ### Profile IDs Organizations, workspaces, and shares are all identified by 19-digit numeric profile IDs. These appear throughout the tool parameters as `workspace_id`, `share_id`, `org_id`, `profile_id`, and `member_id`. Most endpoints also accept custom names as identifiers: | Profile Type | Numeric ID | Custom Name | |-------------|-----------|-------------| | Workspace | 19-digit ID | Folder name (e.g., `my-project`) | | Share | 19-digit ID | URL name (e.g., `q4-financials`) | | Organization | 19-digit ID | Domain name (e.g., `acme`) | | User | 19-digit ID | Email address (e.g., `user@example.com`) | ### QuickShares QuickShares are temporary public download links for individual files in workspaces (not available for shares). They can be accessed without authentication. Expires in seconds from creation (default 10,800 = 3 hours, max 604,800 = 7 days) or as an ISO 8601 datetime via `expires_at`. Max file size: 1 GB. Each quickshare has an opaque identifier used to retrieve metadata and download the file. ### File Preview Files uploaded to Fast.io get automatic preview generation. When humans open a share or workspace, they see the content immediately -- no "download and open in another app" friction. Supported preview formats: - **Images** -- full-resolution with auto-rotation and zoom - **Video** -- HLS adaptive streaming (50--60% faster load than raw video) - **Audio** -- interactive waveform visualization - **PDF** -- page navigation, zoom, text selection - **Spreadsheets** -- grid navigation with multi-sheet support - **Code and text** -- syntax highlighting, markdown rendering Use `storage` action `preview-url` (with `profile_type: "workspace"` or `"share"`) to generate preview URLs. Use `storage` action `preview-transform` (with `profile_type: "workspace"` or `"share"`) for image resize, crop, and format conversion. **Agent use case:** Your generated PDF report does not just appear as a download link. The human sees it rendered inline, can flip through pages, zoom in, and comment on specific sections -- all without leaving the browser. ### Comments and Annotations Humans and agents can leave feedback directly on files, anchored to specific content using the `reference` parameter: - **Image comments** -- anchored to spatial regions (normalized x/y/width/height coordinates) - **Video comments** -- anchored to timestamps with spatial region selection - **Audio comments** -- anchored to timestamps or time ranges - **PDF comments** -- anchored to specific pages with optional text snippet selection - **Text-anchored comments** -- anchored to selected text in markdown/notes using `exact`, `prefix`, `suffix`, `start_offset`, and `end_offset` fields (use `type: "document"` or `type: "text"`) - **Threaded replies** -- single-level threading only; replies to replies are auto-flattened to the parent - **Emoji reactions** -- one reaction per user per comment; adding a new reaction replaces the previous one - **Mention tags** -- reference users and files inline using bracket syntax: `@[profile:id]`, `@[user:opaqueId:Display Name]`, `@[file:fileId:filename.ext]`. Get IDs from member lists, user details, or storage listings. The display name segment is optional for profile tags but recommended for user and file tags Comments use JSON request bodies (`Content-Type: application/json`), unlike most other endpoints which use form-encoded data. **Listing comments:** Use `comment` action `list` for per-file comments and `comment` action `list-all` for all comments across a workspace or share. Both support `sort`, `limit` (2-200), `offset`, `include_deleted`, `reference_type` filter, and `include_total`. **Adding comments:** Use `comment` action `add` with `profile_type`, `profile_id`, `node_id`, and `text`. Optionally include `parent_comment_id` for replies and `reference` to anchor to a specific position. Supports mention tags in the body. Two character limits apply: total body including tags max 8,192 chars, display text (body with `@[...]` tags stripped) max 500 chars. Optionally include `linked_entity_type` and `linked_entity_id` to link the comment to a task or approval at creation time. **Deleting comments:** `comment` action `delete` is recursive -- deleting a parent also removes all replies. `comment` action `bulk-delete` is NOT recursive -- replies to deleted comments are preserved. **Comment Linking:** Comments can be linked to workflow entities (tasks or approvals). Each comment supports one link at a time (nullable). Use `comment` action `link` to associate an existing comment with a task or approval, `comment` action `unlink` to remove the association, and `comment` action `linked` to reverse-lookup all comments linked to a given entity. You can also link at creation time by passing `linked_entity_type` and `linked_entity_id` to the `add` action. Comment responses include `linked_entity_type` and `linked_entity_id` fields (null when unlinked). **Linking users to comments:** The preview URL opens the comments sidebar automatically. Deep link query parameters let you target a specific comment or position: | Parameter | Format | Purpose | |-----------|--------|---------| | `?comment={id}` | Comment opaque ID | Scrolls to and highlights a specific comment for 2 seconds | | `?t={seconds}` | e.g. `?t=45.5` | Seeks to timestamp for audio/video comments | | `?p={pageNum}` | e.g. `?p=3` | Navigates to page for PDF comments | Workspace: `https://{org.domain}.fast.io/workspace/{folder_name}/preview/{file_opaque_id}?comment={comment_id}` Share: `https://go.fast.io/shared/{custom_name}/{title-slug}/preview/{file_opaque_id}?comment={comment_id}` Parameters can be combined -- e.g. `?comment={id}&t=45.5` to deep link to a video comment at a specific timestamp. In shares, the comments sidebar only opens if the share has comments enabled. **Agent use case:** You generate a design mockup. The human comments "Change the header color" on a specific region of the image. You read the comment, see exactly what region they are referring to via the `reference.region` coordinates, and regenerate. **Text-anchored comments (markdown/notes):** To anchor a comment to specific text in a markdown or notes file, use the `reference` parameter with `type: "document"` (or `"text"`, which is an alias) and the text selection fields: - `exact` (string, max 500 chars) -- the selected text verbatim - `prefix` (string, max 100 chars) -- ~30-50 characters of context before the selection for disambiguation - `suffix` (string, max 100 chars) -- ~30-50 characters of context after the selection for disambiguation - `start_offset` (integer) -- character offset from document start (hint for resolving ambiguous matches) - `end_offset` (integer) -- character offset for end of selection (hint for resolving ambiguous matches) At minimum, provide `exact`. The `prefix`/`suffix` fields help locate the selection when the same text appears multiple times. The `start_offset`/`end_offset` fields are optional hints that may not survive document edits. Example -- text-anchored comment on a markdown file: ```json { "action": "add", "profile_type": "workspace", "profile_id": "1234567890123456789", "node_id": "abc123-def456-ghi789", "text": "This section needs a citation", "reference": { "type": "document", "exact": "Studies show a 40% improvement", "prefix": "In the results section, ", "suffix": " compared to the baseline.", "start_offset": 1250, "end_offset": 1280 } } ``` ### URL Import Agents can import files directly from URLs without downloading them locally first. Fast.io's server fetches the file, processes it, and adds it to your workspace or share. - Supports any HTTP/HTTPS URL - Supports OAuth-protected sources: **Google Drive, OneDrive, Dropbox** - Files go through the same processing pipeline (preview generation, AI indexing if intelligence is enabled, virus scanning) Use `upload` action `web-import` with the source URL, target profile, and parent node ID. Use `upload` action `web-status` to check progress and `upload` action `web-list` to list active import jobs. **Agent use case:** A user says "Add this Google Doc to the project." You call `upload` action `web-import` with the URL. Fast.io downloads it server-side, generates previews, indexes it for AI, and it appears in the workspace. No local I/O. ### Metadata Metadata enables structured data annotation on files within workspaces. The system uses a template-based approach (called "views" in the UI): administrators create templates that define the fields (name, type, constraints), then assign a template to the workspace. Files can then have metadata values set against the template fields. Key points: - **Available on all plans** -- metadata templates are no longer Pro/Business-gated. Free and Agent users can create their first template. - **Per-plan caps** -- each plan limits both how many templates a workspace can have and how many files (nodes) each template can hold: | Plan | Templates per workspace | Nodes per template | |----------|-------------------------|--------------------| | Agent | 1 | 10 | | Free | 1 | 10 | | Pro | 2 | 10 | | Business | 10 | 1,000 | Caps are enforced across automatch, manual add, and listings. On downgrade, overflow rows are preserved in storage but hidden by listings. - **Truncation signaling on `metadata-template-preview-match`** -- the response includes `plan_node_limit` (`-1` = unlimited) and `would_truncate_at` (= `min(total_matched, plan_node_limit)` when the cap applies, otherwise = `total_matched`). Doc-recommended frontend heuristic: warn the user when `would_truncate_at < total_matched` — the plan cap is clipping the sampled match count. The MCP `metadata-template-preview-match` handler emits this warning automatically in `_warnings`. Treat `plan_node_limit = -1` as "no cap" in UI. - **Truncation signaling on `metadata-template-list` and `metadata-template-details`** -- the live AI category overview states: *"Listing, details, and preview endpoints return `plan_node_limit`, `is_truncated`, and an unfiltered count alongside the visible (capped) count, so consumers can render upsell messaging."* The current response examples in the live reference don't show these fields explicitly, so verify the exact field names at runtime. The unfiltered count field is named `total_count_unfiltered` on the per-template `nodes/` listing endpoint; the field name on `list`/`details` is not pinned in the docs and may differ. Show an upsell prompt whenever `is_truncated` is true on either endpoint. - **`metadata-template-suggest-fields` concurrency** -- the server rate-limits concurrent calls per user+workspace and returns **409 Conflict** when another suggest-fields call is in flight. Wait a few seconds and retry. (Earlier internal notes incorrectly said 406; live docs are authoritative — it is 409.) - **`nodes/add/` cap-exceeded** (REST endpoint, not exposed as an MCP action) -- returns **400 (Fast.io error code 1605, "Invalid Input")** with a structured "would exceed cap" message. Concurrent calls cannot collectively exceed the cap. To pre-flight, read the per-template nodes listing endpoint and compute remaining slots from `plan_node_limit - total_count_unfiltered`. - **Auto-match silently caps** -- the server-side `auto-match` endpoint (not currently exposed as an MCP action) caps at `plan_node_limit` even when more files are matchable (saves credits and LLM cost). Because neither `auto-match` nor the per-template `nodes/` listing is currently driveable from the MCP tool, agents needing to know exactly how many files were mapped after auto-match must call those REST endpoints directly or surface the gap to the user. - **MCP tool coverage** -- the `workspace` MCP tool exposes template CRUD (`metadata-template-{create,delete,list,details,update,clone}`), workspace assignment (`metadata-template-{assign,unassign,resolve,assignments}`), the view-creation flow (`metadata-template-{preview-match,suggest-fields}`), per-user saved views (`metadata-view-{get,save,delete}`, `metadata-views-list`), saved-view TSV export (`metadata-view-export`), keyword search across metadata values (`metadata-search`), and file-level metadata (`metadata-{get,set,delete,extract}`, `metadata-list-files`, `metadata-list-templates-in-use`, `metadata-versions`). It does **not** currently expose `nodes/add`, `nodes/remove`, the per-template `nodes/` listing, `auto-match`, `extract-all`, or `/metadata/eligible/`. Agents needing those workflows must surface the gap to the user. - **Template categories** -- legal, financial, business, medical, technical, engineering, insurance, educational, multimedia, hr. - **Field types** -- string, int, float, bool, json, url, datetime -- each with optional constraints (min, max, default, fixed_list, can_be_null). - **Two metadata types** -- template metadata conforms to template field definitions; custom metadata is freeform key-value pairs not tied to any template. - **System templates** -- pre-built templates that are automatically cloned when assigned to a workspace, so customizations do not affect the global definition. - **AI extraction** -- the `extract` action uses AI to analyze file content and automatically populate metadata fields. Extracted values are flagged with `is_auto: true`. Consumes AI credits. - **Version history** -- metadata changes are tracked with version snapshots, accessible via the `versions` action. - **Template IDs** are alphanumeric strings prefixed with `mt_` (e.g. `mt_abc123def456`). ### Ownership Transfer The primary way agents deliver value: build something, then give it to a human. Also the recommended action when the agent plan runs out of credits and API calls start returning 402 Payment Required -- transfer the org to a human who can upgrade to a paid plan. **IMPORTANT: Account type restriction.** The transfer/claim workflow (`org` actions `transfer-token-create`, `transfer-token-list`, `transfer-token-delete`, `transfer-claim`) is only available when the agent created an **agent account** (via `auth` action `signup`) and that agent account owns the org. If the agent is signed in with a **human account** (via `auth` action `signin`), the transfer/claim API cannot be used. Human-owned orgs must be upgraded directly by the human through the Fast.io dashboard. **The flow:** 1. Agent creates an agent account with `auth` action `signup` and an org with `org` action `create`, sets up workspaces with `org` action `create-workspace`, uploads files, configures shares 2. Agent generates a transfer token (valid 72 hours) with `org` action `transfer-token-create` 3. Agent sends the claim URL to the human: `https://go.fast.io/claim?token=` 4. Human clicks the link and claims the org with their account **When to transfer:** - The org is ready for human use (workspaces configured, files uploaded, shares set up) - The agent plan runs out of credits (402 Payment Required) -- transfer so the human can upgrade - The human explicitly asks to take over the org **Managing transfer tokens:** - `org` action `transfer-token-list` -- check for existing pending tokens before creating new ones - `org` action `transfer-token-delete` -- revoke a token if the transfer is no longer needed - `org` action `transfer-claim` -- claim an org using a token (used by the receiving human's agent) **What happens after transfer:** - Human becomes the owner of the org and all workspaces - Agent retains admin access (can still manage files and shares) - Human gets a free plan (credit-based, no trial period) - Human can upgrade to Pro or Business at any time **Agent use case:** A user says "Set up a project workspace for my team." You create the org, build out the workspace structure, upload templates, configure shares for client deliverables, invite team members -- then transfer ownership. The human walks into a fully configured platform. You stay on as admin to keep managing things. **402 Payment Required use case (agent account):** While working, the agent hits credit limits. Call `org` action `transfer-token-create`, send the claim URL to the human, and explain they can upgrade to continue. The agent keeps admin access and resumes work once the human upgrades. **402 Payment Required use case (human account):** The agent cannot transfer the org. Instead, inform the user that their org has run out of credits and they need to upgrade their billing plan. Direct them to the Fast.io dashboard or use `org` action `billing-create` to update to a paid plan. ### Workflow (Tasks, Worklogs, Approvals, Todos) Workspaces and shares support an optional workflow layer that adds structured task management, activity logging, approval gates, and simple checklists. Workflow features are controlled by a toggle -- they must be explicitly enabled before use. On shares, workflow access requires admin or named member role -- guests and view-only users cannot access workflow features. #### Enabling Workflow - **Workspaces:** `workspace` action `enable-workflow` with `workspace_id` - **Shares:** `share` action `enable-workflow` with `share_id` Check whether workflow is enabled via `workspace` action `details` or `share` action `details` -- look for `workflow: true` in the response. Disabling workflow (`workspace` action `disable-workflow` or `share` action `disable-workflow`) makes all workflow data inaccessible but preserves it. Re-enabling restores access. #### Task Lists and Tasks Tasks are organized into lists. Each workspace or share can have multiple task lists, and each list contains individual tasks. - **Task lists** have a name and optional description. Create with `task` action `create-list`, list with `task` action `list-lists`. - **Tasks** have a title, description, status, priority, assignee, dependencies, and optional node link. Create with `task` action `create-task`, list with `task` action `list-tasks`. - **Statuses:** `pending`, `in_progress`, `complete`, `blocked` - **Priorities:** 0 = none, 1 = low, 2 = medium, 3 = high, 4 = critical - **Assignees** are profile IDs (workspace or share members, including pending members). Use `task` action `assign-task` to assign or unassign. Pending members (invited but not yet registered) can be assigned tasks — their assignments are preserved when they sign up. - **Bulk operations:** `task` action `bulk-status` changes status on up to 100 tasks at once. - **Moving tasks:** `task` action `move-task` moves a task from one list to another within the same profile. Requires the source `list_id`, `task_id`, and `target_task_list_id`. Optionally set `sort_order` to control position in the target list (default: 0). - **Reordering:** `task` action `reorder-tasks` sets the display order of tasks within a list. `task` action `reorder-lists` sets the display order of task lists within a profile. Pass arrays of IDs in the desired order; the server converts them to `{id, sort_order}` objects for the API. - **Creator tracking:** Tasks and task lists include a `created_by` field (profile ID of the creator). - **Filtered lists:** `task` action `filtered-list` returns tasks filtered by category -- "assigned" (assigned to me), "created" (created by me), or "status" (by status, requires `status` param). Scoped to a workspace or share. - **Summary:** `task` action `summary` returns lightweight counts -- total tasks, breakdown by status, assigned-to-me, and created-by-me. - **Markdown output:** Pass `format: "md"` to get human-readable markdown instead of JSON. #### Worklogs Worklogs are append-only chronological activity logs scoped to tasks, task lists, or profiles (workspaces and shares). Entries cannot be edited or deleted after creation. - **Entries:** Regular log entries appended with `worklog` action `append`. Use for progress updates, decisions, reasoning, and status changes. - **Interjections:** Priority corrections created with `worklog` action `interject`. Interjections are always urgent and require acknowledgement from other participants. - **Acknowledgement:** `worklog` action `acknowledge` marks an interjection as seen. `worklog` action `unacknowledged` lists interjections that still need acknowledgement. Entries include an `acknowledgable` boolean -- when `true`, the entry is an unacknowledged interjection that can be acknowledged. - **Response fields:** Entries include `acknowledged` (boolean), `acknowledgable` (boolean), `updated` (`YYYY-MM-DD HH:MM:SS UTC` timestamp), and `created` (`YYYY-MM-DD HH:MM:SS UTC` timestamp). - **Profile-level listing:** `worklog` action `profile-list` lists all worklog entries at the workspace or share level (different from `list` which is entity-scoped). - **Filtered lists:** `worklog` action `filtered-list` returns worklogs filtered by category -- "authored" (worklogs authored by me) or "interjections" (interjections targeted at me). Optional `type` sub-filter ("info" or "interjection"). - **Summary:** `worklog` action `summary` returns lightweight counts -- total entries, breakdown by entry type, authored-by-me, and pending interjections. - **Markdown output:** Pass `format: "md"` for human-readable output. ### Comments & Discussions -- Quick Start **When to use:** leave feedback on a file, start a container-level discussion, or attach a note to a workflow approval/task. **Comments are JSON** -- always use JSON request bodies (`Content-Type: application/json`). This is the #1 source of 406 errors on the comment API. **Three relationship modes -- pick one before you call:** **1. Node-attached (thread on a specific file/folder):** - `comment` action `add` with `profile_type`, `profile_id`, `node_id`, `text` (and optional `reference` for anchoring, `parent_comment_id` for replies). - Wraps `POST /comments/{entity_type}/{parent_id}/{node_id}/`. List with action `list`. **2. Workspace/share-attached (top-level container thread):** - Not exposed by `comment` action `add` (which requires `node_id`). For container-level comments, call the underlying endpoint via `execute`: `POST /comments/{entity_type}/{parent_id}/` with JSON body `{body, parent_id?}`. List via `comment` action `list-all`. **3. Workflow-linked (attach existing comment to an approval or task):** - Step A: create a comment via mode 1 or 2. - Step B: `comment` action `link` with `comment_id`, `linked_entity_type: "task" | "approval"`, `linked_entity_id`. - Reverse-lookup with `comment` action `linked`. Detach with `comment` action `unlink`. A comment can have at most one workflow link at a time. **Valid `entity_type` / `profile_type` values:** - Create/list endpoints: `"workspace"` or `"share"` ONLY. - Link/unlink/linked endpoints: `"task"` or `"approval"` ONLY (not `worklog_entry`, not `node`, not `share`). **Threading:** single-level only. Set `parent_comment_id` (body field: `parent_id`) to the top-level comment id. Replies to replies auto-flatten as siblings. **Reactions:** `comment` action `reaction-add` with `comment_id` + `emoji`. One reaction per user per comment -- new ones replace the previous. **Anti-patterns:** - Don't pass `entity_type: "approval"` (or `"task"`) to a create endpoint -- they only accept `"workspace"` or `"share"`. To comment on an approval, create on the parent workspace/share first, then LINK. - Don't hand-roll `/approvals/{id}/comments/` or `/tasks/{id}/comments/` -- no such paths exist. - Don't use form-encoded bodies -- comments are JSON everywhere. In code-mode, that's `fastio.postJson()`, not `fastio.post()`. - Don't mix a `node_id` with a `parent_id` from a different workspace/share -- the node must live under the parent you name. 404 usually means wrong parent. - Don't try to link to `worklog_entry` -- only `task` and `approval` are link targets. ### Workflow Approvals -- Quick Start **When to use:** a file, folder, or task needs formal sign-off from one or more reviewers. **Approvals attach to entities directly** -- not to shares. Common mistake: creating a share to hold approvals. Don't. Shares are for distribution (Send/Receive/Exchange); approvals are review gates that live on the entity itself. **Step 1 -- Enable workflow on the workspace (one time, per workspace):** - `workspace` action `enable-workflow` with `workspace_id`. **Step 2 -- Create one approval per reviewer on the target node:** - `approval` action `create` with: - `profile_type: "workspace"` (or `"share"`), `profile_id: ` - `entity_type: "node"` (for a file or folder) - `entity_id: ` - `description` (the review request, 1-65535 chars) - `approver_id: ` -- the reviewer (must be a member of the profile; pending members are fine) - For multiple reviewers, repeat this call N times with different `approver_id` values. (A share-scoped `bulk-create` exists for "approve every file in this share" — see the **Approvals** tool reference below. There is no bulk-create for the "one node, many reviewers" pattern.) **Valid `entity_type` values:** `node` (file/folder), `task`, `worklog_entry`, `share`. Use `node` for file/folder reviews. **Resolve:** `approval` action `resolve` with `approval_id` and `resolve_action: "approve" | "reject"` (optional `comment`). **Anti-patterns to avoid:** - Don't create a share of the file -- approvals go on the node directly. - Don't create a task just to hold an approval on a file -- use `entity_type: "node"`. - Don't create todos -- todos are checklists, not review gates. - `approver_id` is a single user, not a group. For 3 reviewers, make 3 calls. #### Approvals Formal approval requests scoped to tasks, storage nodes, worklog entries, or shares. Use when a decision requires explicit sign-off. - **Create:** `approval` action `create` with `profile_type`, `profile_id`, `entity_type` ("task", "node", "worklog_entry", or "share"), `entity_id`, `description` (1-65535 chars), and optionally `approver_id` (a single profile ID, must be an entity member — can be a pending member). - **Resolve:** `approval` action `resolve` with `profile_type`, `profile_id`, `approval_id`, and `resolve_action: "approve"` or `"reject"` plus an optional comment. Only designated approvers can resolve. - **Bulk operations:** `approval` action `bulk-create` creates approval requests for every file and note in a share (max 50 nodes). `approval` action `bulk-approve` resolves all pending approvals in a share (skips stale approvals where version_match=false). `approval` action `bulk-reject` rejects all pending approvals in a share. - **Version tracking:** Approvals track `version_id` and `version_match`. If a node is modified after an approval is created, `version_match` becomes false (stale). Bulk operations skip stale approvals to prevent resolving outdated content. - **Filtered lists:** `approval` action `filtered-list` returns approvals filtered by category -- "pending", "created", "assigned", or "resolved". Scope to a workspace or share with `profile_type`/`profile_id`, or omit both for a cross-profile user-level view. - **Summary:** `approval` action `summary` returns lightweight counts -- created-by-me and assigned-to-me breakdowns with pending/approved/rejected counts. - **Update:** `approval` action `update` with `profile_type`, `profile_id`, and `approval_id` modifies a pending approval -- change description, approver, deadline, node reference, or metadata. Only pending approvals can be updated. - **Delete:** `approval` action `delete` with `profile_type`, `profile_id`, and `approval_id` permanently removes an approval (any status). `approval` action `bulk-delete` permanently removes all approvals in a share (up to 500). - **Statuses:** `pending`, `approved`, `rejected` - **Markdown output:** Pass `format: "md"` for human-readable output. #### Todos Simple flat checklists scoped to workspaces and shares. No nesting -- just a list of items that can be checked off. - **Create:** `todo` action `create` with a title. Optional `assignee_id` — can be a pending member. - **Toggle:** `todo` action `toggle` flips the done state of a single todo. `todo` action `bulk-toggle` sets done state on up to 100 todos at once. - **Update/Delete:** `todo` action `update` changes title or assignee. `todo` action `delete` soft-deletes a todo. - **Creator tracking:** Todos include a `created_by` field (profile ID of the creator). - **Filtered lists:** `todo` action `filtered-list` returns todos filtered by category -- "assigned" (assigned to me), "created" (created by me), "done" (completed), or "pending" (incomplete). - **Summary:** `todo` action `summary` returns lightweight counts -- total, done, pending, assigned-to-me, and created-by-me. - **Markdown output:** Pass `format: "md"` for human-readable output. #### Notes as Agent Knowledge Layer Notes (`type: "note"`) are markdown files stored in workspace storage (see **Notes** above). When combined with workflow features, notes become a knowledge layer: - **Automatic AI indexing:** When workspace intelligence is enabled, notes are ingested and indexed for RAG just like uploaded files. - **Link tasks to notes:** Tasks can reference storage nodes, including notes. Create context notes for project background, requirements, or reference material, then create tasks that link to those notes for full context. - **Worklogs for reasoning:** Use worklog entries to record decisions, progress, and reasoning over time. The chronological log builds a narrative that complements the structured task list. - **AI can search all context:** With intelligence enabled, AI chat can search across notes, worklogs, task descriptions, and uploaded files -- giving comprehensive answers grounded in the project's full history. **Recommended pattern:** Create notes for project context and requirements. Create task lists for work phases. Link tasks to relevant notes. Log progress with worklogs. Request approvals for decisions. The AI can then answer questions like "Why did we choose this approach?" by searching across all of these artifacts. ### Permission Parameter Values Several tools use permission parameters with specific allowed values. Use these exact strings when calling the tools. #### Organization Creation (`org` action `create`) | Parameter | Allowed Values | Default | |-----------|----------------|---------| | `perm_member_manage` | `Owner only`, `Admin or above`, `Member or above` | `Member or above` | | `industry` | `unspecified`, `technology`, `healthcare`, `financial`, `education`, `manufacturing`, `construction`, `professional`, `media`, `retail`, `real_estate`, `logistics`, `energy`, `automotive`, `agriculture`, `pharmaceutical`, `legal`, `government`, `non_profit`, `insurance`, `telecommunications`, `research`, `entertainment`, `architecture`, `consulting`, `marketing` | `unspecified` | | `background_mode` | `stretched`, `fixed` | `stretched` | #### Workspace Creation (`org` action `create-workspace`) and Update (`workspace` action `update`) | Parameter | Allowed Values | Default | |-----------|----------------|---------| | `perm_join` | `Only Org Owners`, `Admin or above`, `Member or above` | `Member or above` | | `perm_member_manage` | `Admin or above`, `Member or above` | `Member or above` | #### Share Creation (`share` action `create`) | Parameter | Allowed Values | Default | |-----------|----------------|---------| | `share_type` | `send`, `receive`, `exchange` | `exchange` | | `storage_mode` | `independent`, `workspace_folder` | `independent` | | `access_options` | `Only members of the Share or Workspace`, `Members of the Share, Workspace or Org`, `Anyone with a registered account`, `Anyone with the link` | `Only members of the Share or Workspace` | | `invite` | `owners`, `guests` | `owners` | | `notify` | `never`, `notify_on_file_received`, `notify_on_file_sent_or_received` | `never` | | `display_type` | `list`, `grid` | `grid` | | `intelligence` | `true`, `false` | `false` (always `false` for `workspace_folder` shares) | | `comments_enabled` | `true`, `false` | `true` | | `download_security` | `off`, `medium`, `high` | `off` | | `guest_chat_enabled` | `true`, `false` | `false` | | `anonymous_uploads_enabled` | `true`, `false` | `false` | | `workspace_style` | `true`, `false` | `true` | | `background_image` | `0`-`128` | `0` | **Share constraints:** - Receive and Exchange shares cannot use `Anyone with the link` access -- this option is only available for Send shares. - Password protection (`password` parameter) is only allowed when `access_options` is `Anyone with the link`. - Expiration (`expires` parameter in MySQL format `YYYY-MM-DD HH:MM:SS`) is not allowed on `workspace_folder` shares. - Intelligence is not supported on `workspace_folder` shares. Creating a workspace folder share always sets `intelligence=false` regardless of the value passed. Updating a workspace folder share with `intelligence=true` returns an error. AI chat with file/folder scope and semantic search are not available on workspace folder shares — use the parent workspace's AI endpoints instead. Basic chat and `files_attach` (direct file attachment) still work. - Field length and format constraints for `custom_name`, `title`, and `description` are documented in the **Profile Field Constraints** table below. - Color parameters (`accent_color`, `background_color1`, `background_color2`) accept JSON strings. - `create_folder` creates a new workspace folder for the share when used with `storage_mode='workspace_folder'`. - `anonymous_uploads_enabled` allows guests to upload files to Receive/Exchange shares without creating an account. Requires an "Anyone" access level. Not applicable to Send shares or Portals. ### Profile Field Constraints All profile fields are validated server-side. Requests that violate these constraints are rejected with a 400 error. | Entity | Field | API Key | Min | Max | Pattern | Required | Nullable | |--------|-------|---------|-----|-----|---------|----------|----------| | Org | domain | `domain` | 2 | 63 | `^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?$` | Yes (create) | No | | Org | name | `name` | 3 | 100 | No control chars | Yes | No | | Org | description | `description` | 10 | 1000 | No control chars | No | Yes | | Workspace | folder_name | `folder_name` | 4 | 80 | `^[\p{L}\p{N}-]+$` (letters, digits, hyphens) | Yes (create) | No | | Workspace | name | `name` | 2 | 100 | No control chars | Yes | No | | Workspace | description | `description` | 10 | 1000 | No control chars | No | Yes | | Share | custom_name | `custom_name` | 4 | 80 | `^[\p{L}\p{N}]+$` (letters, digits only) | Yes (create) | No | | Share | custom_url | `custom_url` | 10 | 100 | — | Yes | Yes | | Share | title | `title` | 2 | 80 | No control chars | Yes | Yes | | Share | description | `description` | 10 | 500 | No control chars | No | Yes | - **"No control chars"** = rejects Unicode control characters (`\p{C}`) - **Org domain**: lowercase ASCII alphanumeric + hyphens; cannot start/end with hyphen - **Workspace folder_name**: Unicode letters, digits, and hyphens. **Globally unique** -- not scoped to an org. Recommend `{org_id}-{name}` convention to avoid collisions (auto-applied by `create-workspace` when name is taken) - **Share custom_name**: Unicode letters and digits only (no hyphens or special chars) - **Share description** max is 500 (org/workspace is 1000) --- ## 4. Agent Plan -- Free Tier The agent plan is a free tier designed for AI agents. No credit card, no trial period, no expiration. Enough resources to build and demonstrate value, with room to grow when the org transfers to a human on a paid plan. ### Resource Limits | Resource | Included | |----------|----------| | **Price** | $0 -- no credit card, no trial period, no expiration | | **Storage** | 50 GB | | **Max file size** | 1 GB | | **Monthly credits** | 5,000 (resets every 30 days) | | **Workspaces** | 5 | | **Shares** | 50 | | **Members per workspace** | 5 | | **Share invitations** | 10 per share | | **Account auto-deletion** | Never | ### Credit Costs All platform activity consumes credits from the monthly 5,000 allowance: | Resource | Cost | |----------|------| | Storage | 100 credits/GB | | Bandwidth | 212 credits/GB | | AI chat tokens | 1 credit per 100 tokens | | Document pages ingested | 10 credits/page | | Video ingested | 5 credits/second | | Audio ingested | 0.5 credits/second | | Images ingested | 5 credits/image | | File conversions | 25 credits/conversion | When credits run out, the org enters a reduced-capability state and API calls return 402 Payment Required. The org is never deleted. Use `org` action `limits` to check current credit usage and remaining balance. **When you hit 402 or run low on credits:** - **Agent account (created via `auth` action `signup`):** Transfer the org to the human. Call `org` action `transfer-token-create` to generate a transfer token, then send the human the claim URL: `https://go.fast.io/claim?token=`. Once they claim the org they can upgrade to a paid plan with unlimited credits. You retain admin access and can resume work immediately after the upgrade. This is the expected workflow -- agents build on the free plan, then hand off to humans who pay when they are ready. - **Human account (signed in via `auth` action `signin`):** You cannot use the transfer/claim API. Tell the user they need to upgrade the org's billing plan directly. They can do this from the Fast.io dashboard or by calling `org` action `billing-create` to update their subscription to a paid plan. ### After Transfer -- Human Plan Options Once an agent transfers an org to a human, the human gets a free plan (credit-based, no trial period) and can upgrade: | Feature | Agent (Free) | Free (Human) | Pro | Business | |---------|-------------|--------------|-----|----------| | Monthly credits | 5,000 | 5,000 | Unlimited | Unlimited | | Storage | 50 GB | 50 GB | 1 TB | 5 TB | | Max file size | 1 GB | 1 GB | 25 GB | 50 GB | | Workspaces | 5 | 5 | 10 | 1,000 | | Shares | 50 | 50 | 1,000 | 50,000 | The transfer flow is the primary way agents deliver value: set everything up on the free agent plan, then hand it off. The human upgrades when they are ready, and the agent retains admin access to keep managing things. --- ## 5. Tool Categories The 19 tools use action-based routing. Each tool covers a specific area of the Fast.io platform and exposes multiple actions. ### auth Authentication, sign-in/sign-up, two-factor authentication, API key management, and OAuth session management. This is always the starting point for any agent interaction. **Actions:** signin, signout, signup, check, session, status, set-api-key, email-check, email-verify, password-reset-request, password-reset, 2fa-verify, 2fa-status, 2fa-enable, 2fa-disable, 2fa-send, 2fa-verify-setup, pkce-login, pkce-complete, api-key-create, api-key-update, api-key-list, api-key-get, api-key-delete, oauth-list, oauth-details, oauth-revoke, oauth-revoke-all ### user Retrieve and update the current user profile, search your contacts, manage invitations, upload and delete user assets (profile photos), check account eligibility, list shares the user belongs to, and manage personal AI instructions (markdown guidance the platform applies to AI features). **Actions:** me, update, search-contacts, close, details-by-id, profiles, allowed, org-limits, list-shares, invitation-list, invitation-details, accept-all-invitations, asset-upload, asset-delete, asset-types, asset-list, instructions-get, instructions-set, instructions-clear > `search-contacts` searches your personal contact list (prior interactions) and returns `{email: name}` only — no user_id, no context scope. To find members of a specific workspace/share/org, use `org action=members`, `workspace action=members`, or `share action=members`. > AI instructions: `instructions-get` / `instructions-set` / `instructions-clear` manage a single self-scoped markdown slot at `/user/me/instructions/` (max 65536 bytes UTF-8, full replace on set, soft-clear preserves audit row). The user profile has no `me` scope variant — it's already self-only. First read returns `content: ""` with null timestamps, not a 404. ### org Organization CRUD, member management, billing and subscription operations, workspace creation, invitation workflows, asset management (upload, delete), organization discovery, ownership transfer, custom domain management, and AI instructions (org-wide and per-user slots). **Actions:** list, details, create, update, close, public-details, limits, list-workspaces, list-shares, create-workspace, billing-plans, billing-create, billing-cancel, billing-details, billing-activate, billing-reset, billing-members, billing-meters, members, invite-member, remove-member, update-member-role, member-details, leave, transfer-ownership, join, invitations-list, invitation-update, invitation-delete, transfer-token-create, transfer-token-list, transfer-token-delete, transfer-claim, discover-all, discover-available, discover-check-domain, discover-external, asset-upload, asset-delete, asset-types, asset-list, custom-domain-get, custom-domain-create, custom-domain-delete, custom-domain-validate, instructions-get, instructions-set, instructions-clear > **Per-entity verbosity:** `list`, `discover-all`, `discover-available`, `discover-external`, `members`, `list-workspaces` accept a `detail` parameter (`terse` | `standard` | `full`) and default to `terse` (terse fields per the API spec: `id`, `domain`, `name`, `logo`). `details` defaults to `full` (drill-down adds `subscriber_trial_credits`, `billing_email`, social URLs, `encryption_key`, `perm_*` blocks, `dmca`, `owner_defined`, `platform`, `storage` on top of the standard surface — `description`, `plan`, `user_permission`, `user_status`, `member`, `closed`/`locked`/`suspended`, `created`/`updated`, `parent`, `capabilities`, `custom_domain`, `accent_color`, background and homepage, subscriber/billing flags). Pass an explicit `detail` to override. Per the API spec, the orgs spec enumerates `output=` for org-object endpoints — `details`, `list` (`/orgs/list/`), `discover-all`, `discover-available`, `discover-external` all fall under that scope. `list-workspaces` returns workspace objects so it falls under the workspaces spec (also enumerated). `members` returns member rows and is NOT enumerated for `output=` in any per-category spec, so passing `detail` there may be a silent no-op until the platform's compact-response coverage extends. Wiring is preserved end-to-end. `discover-check-domain` is a boolean availability check and does not accept `detail`. > AI instructions: `instructions-get`/`instructions-set`/`instructions-clear` accept an optional `scope` param: `profile` (default, org-wide slot — owner/admin only, 403 code 1680 for non-admins) or `me` (per-user slot — any member). The two scopes are independent and do NOT merge server-side; concat client-side if you want a combined view. content max 65536 bytes UTF-8, full replace on set, soft-clear preserves the audit row. ### workspace Workspace-level settings, lifecycle operations (update, delete, archive, unarchive), listing and importing shares, managing workspace assets, workspace discovery, notes (create, read, update), quickshare management, metadata operations (template CRUD, assignment, file metadata get/set/delete, AI extraction), workflow toggle (enable/disable tasks, worklogs, approvals, and todos), and AI instructions (workspace-wide and per-user slots). **Actions:** list, details, update, delete, archive, unarchive, members, list-shares, import-share, available, check-name, create-note, read-note, update-note, quickshare-get, quickshare-delete, quickshares-list, metadata-template-create, metadata-template-delete, metadata-template-list, metadata-template-details, metadata-template-update, metadata-template-clone, metadata-template-preview-match, metadata-template-suggest-fields, metadata-template-assign, metadata-template-unassign, metadata-template-resolve, metadata-template-assignments, metadata-view-get, metadata-view-save, metadata-view-delete, metadata-views-list, metadata-view-export, metadata-search, metadata-get, metadata-set, metadata-delete, metadata-extract, jobs-status, metadata-list-files, metadata-list-templates-in-use, metadata-versions, enable-workflow, disable-workflow, enable-import, disable-import, instructions-get, instructions-set, instructions-clear > **Per-entity verbosity:** `list`, `available`, `members`, `list-shares` accept a `detail` parameter (`terse` | `standard` | `full`) and default to `terse` (terse fields per the API spec: `id`, `name`, `folder_name`, `org_domain`, `user_status`). `details` defaults to `full` (drill-down adds `cloud_import`, `comments`, `chat`, `search`, `assets`, `workflow_permissions`, remaining branding, `perm_*` blocks, `platform`, `suspended`, `owner_defined`, `parents` on top of the standard surface — `description`, `workspace_level`, `closed`/`archived`/`locked`, `storage`, `created`/`updated`, `logo`, `accent_color`, `org_custom_hostname`, `intelligence`, `workflow`, `capabilities`). Pass an explicit `detail` to override. Per the API spec, the workspaces spec enumerates `output=` for workspace-object endpoints — `list`, `available`, `details`. `list-shares` returns share objects so it falls under the shares spec (also enumerated). `members` returns member rows and is NOT enumerated for `output=` in any per-category spec, so passing `detail` there may be a silent no-op until the platform's compact-response coverage extends. Wiring is preserved end-to-end. Metadata sub-actions and other workspace operations do not currently accept `detail`. > AI instructions: `instructions-get`/`instructions-set`/`instructions-clear` accept an optional `scope` param: `profile` (default, workspace-wide slot — owner/admin only, 403 code 1680 for non-admins) or `me` (per-user slot — any member, no guests). The two scopes are independent and do NOT merge server-side; concat client-side if you want a combined view. content max 65536 bytes UTF-8, full replace on set, soft-clear preserves the audit row. ### share Share CRUD, public details, archiving, password authentication, asset management, share name availability checks, workflow toggle (enable/disable tasks, worklogs, approvals, and todos), and AI instructions (share-wide and per-user slots). **Actions:** list, details, create, update, delete, public-details, archive, unarchive, password-auth, members, available, check-name, quickshare-create, enable-workflow, disable-workflow, instructions-get, instructions-set, instructions-clear > **Per-entity verbosity:** `list`, `available`, `members` accept a `detail` parameter (`terse` | `standard` | `full`) and default to `terse` (terse fields per the API spec: `id`, `title`, `share_type`, `share_level`, `share_root_id` (members-only), `creator` scalar user id). `public-details` defaults to `standard` (adds `share_category`, `storage_mode`, `folder_node_id`, `share_link` object, parent linkage, lifecycle flags incl. `locked`, `custom_name`, `custom_url`, `description`, `download_security`, `expires`, `created`/`updated`, `guest_chat_enabled`/`anonymous_uploads_enabled`, `user_status`, `intelligence`, `workflow` — no member roster, no owner-defined data). `details` defaults to `full` (member-facing surface: `capabilities`, `perm_*` blocks, activity tracking, `comments`, `event_flow`, `filesystem`, `invite`, `member_visibility`, `multiplayer`, `chat`, `search`, `assets`, `workflow_permissions`, `access_options`, `display_type`, full branding (accent color, logo, background), `password`, `platform`, `notify`, custom links, `owner_defined`, `deleted`, `storage`, `suspended`, `parents`). Pass an explicit `detail` to override. Per the API spec, the shares spec enumerates `output=` for share-object endpoints — `details`, `public-details`, `list` (`/shares/all/`), `available`. `members` returns member rows and is NOT enumerated for `output=` in any per-category spec, so passing `detail` there may be a silent no-op until the platform's compact-response coverage extends. Wiring is preserved end-to-end so callers can opt in once the server respects it. > AI instructions: `instructions-get`/`instructions-set`/`instructions-clear` accept an optional `scope` param: `profile` (default, share-wide slot — owner/admin only, 403 code 166463 for non-admins) or `me` (per-user slot — registered members only, 403 code 185733 for anonymous/link guests). The two scopes are independent and do NOT merge server-side; concat client-side if you want a combined view. content max 65536 bytes UTF-8, full replace on set, soft-clear preserves the audit row. ### storage File and folder operations within workspaces and shares. List, list recently modified files across all folders, create folders, move, copy, delete, rename, purge, restore, search (keyword or semantic when intelligence is enabled), add files from uploads, add share links, transfer nodes, manage trash, version operations, file locking, and preview/transform URL generation. Requires `profile_type` parameter (also accepted as `context_type`) (`workspace` or `share`). > **Per-node verbosity:** `list`, `recent`, `search`, `trash-list`, and `details` accept a `detail` parameter (`terse` | `standard` | `full`). Defaults: `list`/`recent`/`search`/`trash-list` → `terse` (compact rows: id, type, name, parent, mimetype, size, modified). `details` → `full` (drill-down — keeps ai.attach, virus, hashes, file_attributes, lock_info, long-form summaries available without an extra round-trip). Search bumps default to `full` automatically when the legacy `details: "true"` flag is also set, honoring the explicit hydration intent. **Search-specific:** semantic-search hits include `content_snippet` (the matching text chunk). The platform caps the snippet per detail level — `terse` → ~200 bytes, `standard` → ~600 bytes, `full` → untruncated. UTF-8 safe (won't split multi-byte sequences); a trailing `…` indicates truncation, so a hit with `snippet.endsWith('…')` has more content available — bump `detail` to retrieve more. Pass an explicit `detail` to override any default. Not to be confused with `details` (search-only `"true"|"false"` flag). > **REPLACE-by-default on copy/move:** If a file with the same name already exists in the destination folder, the existing target is silently sent to trash for rollback. The MCP response includes a `_warnings` block flagging this on every copy/move call (whether or not a collision actually happened — the API doesn't return a `replaced` indicator). Rename the source first if you want to avoid overwriting. > **Search at terse cannot distinguish trashed nodes from live ones.** Keyword search may return trashed nodes; the terse projection from the API does not include `deleted`/`parent: trash` fields. Bump `detail` to `standard` or higher to see trash status, or check the runtime `_next` hint in the search response. **Actions:** list, recent, details, search, trash-list, create-folder, copy, move, delete, rename, purge, restore, add-file, add-link, transfer, version-list, version-restore, lock-acquire, lock-status, lock-release, preview-url, preview-transform ### upload File upload operations. Chunked upload lifecycle (create session, upload chunks as plain text, base64-encoded binary, or blob reference, finalize, check status, cancel), single-call streaming uploads (`stream-upload` creates a stream session, streams the bytes, and auto-finalizes in one call), bulk uploads of many small files in one round-trip (`batch`), web imports from external URLs, upload limits and file extension restrictions, and session management. Large binary data flows through the `POST /blob` sidecar (100 MB cap per blob); for small binaries when the agent cannot reach `/blob` (sandboxed environments), use `content_base64` instead — the server decodes it server-side, capped only by MCP transport message size. > **`folder_id` alias for `parent_node_id`:** On `create-session`, `stream-upload`, and `web-import`, `folder_id` is accepted as an alias for `parent_node_id` — the canonical API-internal field name surfaces in finalize/status responses, so agents that read those responses and try to pass `folder_id` back will get the same behavior. Pass either name; they're equivalent. If both are passed with different values, `parent_node_id` wins. Note: `batch` action uses `folder_id` as its canonical name (target folder for the batch), NOT as an alias for `parent_node_id`. **Actions:** create-session, stream-upload, batch, chunk, stream, finalize, status, cancel, list-sessions, cancel-all, chunk-status, chunk-delete, web-import, web-list, web-cancel, web-status, limits, extensions, blob-info ### download Generate download URLs and ZIP archive URLs for workspace files, share files, and quickshare links. MCP tools cannot stream binary data -- these actions return URLs that can be opened in a browser or passed to download utilities. Requires `profile_type` parameter (also accepted as `context_type`) (`workspace` or `share`) for file-url and zip-url actions. Responses include a `resource_uri` field (e.g. `download://workspace/{id}/{node_id}`) that MCP clients can use to read file content directly via MCP resources. Direct download URLs include `?error=html` so errors render as human-readable HTML in browsers. **Actions:** file-url, zip-url, quickshare-details ### ai AI-powered RAG chat, document analysis, and shareable summaries in workspaces and shares. Create chats, send messages, read AI responses (with polling), list and manage chats, publish private chats, generate AI share markdown, track AI token usage, and auto-title generation. Requires `profile_type` parameter (also accepted as `context_type`) (`workspace` or `share`). **Actions:** chat-create, chat-list, chat-details, chat-update, chat-delete, chat-publish, chat-cancel, message-send, message-list, message-details, message-read, share-generate, transactions, autotitle > **Per-entity verbosity:** `chat-list`, `message-list` accept a `detail` parameter (`terse` | `standard` | `full`) and default to `terse` (id, title/excerpt, created, last activity, message count). `chat-details`, `message-details` default to `full` (full chat metadata: participants, attached/scoped files, publish state; message details add full response text, citations, token usage, files_attach payload). Pass an explicit `detail` to override. Mutation actions (chat-create, chat-update, chat-delete, chat-publish, chat-cancel, message-send, share-generate, autotitle), `transactions` (account usage), and the `message-read` polling loop do not accept `detail`. **Verification gap:** the AI API per-category spec only enumerates `output=` on metadata sub-endpoints; chat and message endpoints don't enumerate it, so passing `detail` here may currently be a silent no-op until the platform's compact-response coverage extends. Wiring is preserved end-to-end so callers can opt in once the server respects it. ### comment Comments are scoped to `{entity_type}/{parent_id}/{node_id}` where entity_type is `workspace` or `share`, parent_id is the 19-digit profile ID, and node_id is the storage node opaque ID. List comments on files (per-node and profile-wide with sort/limit/offset/filter params), add comments with optional reference anchoring (image regions, video/audio timestamps, PDF pages with text selection, text selections in markdown/notes), single-level threaded replies, recursive single delete, non-recursive bulk delete, get comment details, emoji reactions (one per user per comment), and workflow linking (link/unlink comments to tasks or approvals, reverse lookup). Comments use JSON request bodies. **Actions:** list, list-all, add, delete, bulk-delete, details, reaction-add, reaction-remove, link, unlink, linked > **Per-comment verbosity:** `list`, `list-all`, `linked` accept a `detail` parameter (`terse` | `standard` | `full`) and default to `terse` (id, body excerpt, author handle, created, parent_id, node_id). `details` defaults to `full` (long-form thread context, mention expansions, linked workflow entity details, full reaction roster, extended audit metadata). Pass an explicit `detail` to override. **Verification gap:** the comments API per-category spec does not currently enumerate an `output=` section, so passing `detail` may be a silent no-op until the platform's compact-response coverage extends to comments. Wiring is preserved end-to-end so callers can opt in once the server respects it. ### event Search the audit/event log with rich filtering by category, subcategory, and event name (see **Event Filtering Reference** in section 7 for the full taxonomy). Get AI-powered summaries of activity, retrieve full details for individual events, list recent activity, and long-poll for activity changes. **Actions:** search, summarize, details, activity-list, activity-poll > **Two scope patterns by action.** `event search`, `event summarize`, and `event details` use filter-style scope params (`workspace_id`, `share_id`, `org_id`, `user_id` — combine for AND-narrowing). `event activity-list` and `event activity-poll` use the generic profile-context pattern (`profile_type` + `profile_id`, or aliases `context_type` + `context_id`). Mixing them silently drops the wrong-shape params and the platform returns error 10262. > **Per-event verbosity:** `search`, `activity-list`, `activity-poll` accept a `detail` parameter (`terse` | `standard` | `full`) and default to `terse` (terse fields per the API spec: `event_id`, `event`, `category`, `object_id`, `created`). `summarize` defaults to `standard` (envelope around the AI summary). `details` defaults to `full` (adds `required_params`, `requires_parent_node`, `permission` on top of the standard surface — `sub_category`, `calling_user`, `org_id`/`workspace_id`/`user_id`/`share_id`, `acknowledged`, `template` (description + params), `severity`, `visibility`, `notification`). Pass an explicit `detail` to override. Per the API spec, only `search` and `details` (event-object endpoints) currently honor `output=`; `summarize`, `activity-list`, and `activity-poll` declare fixed response shapes, so passing `detail` there is a silent no-op until the API ships verbosity for those endpoints. ### member Member management for workspaces and shares. Add, remove, update roles, transfer ownership, leave, join, and join via invitation. Member lists include both active and pending (invited but not yet registered) members — pending members have `status: "pending"` and an `invite` object with `id`, `created`, and `expires` fields. Requires `entity_type` parameter (`workspace` or `share`). **Actions:** add, remove, details, update, transfer-ownership, leave, join, join-invitation ### invitation Invitation management for workspaces and shares. List invitations, list by state, update, and delete/revoke. Deleting a pending member's invitation also removes them from the member list and unassigns their workflow items (tasks, approvals, todos). Requires `entity_type` parameter (`workspace` or `share`). **Actions:** list, list-by-state, update, delete ### asset Asset management (upload, delete, list, read) for organizations, workspaces, shares, and users. Requires `entity_type` parameter (`org`, `workspace`, `share`, or `user`). **Actions:** upload, delete, types, list, read ### task Task list and task management for workspaces and shares. Create and manage task lists, then create tasks within them with statuses, priorities, assignees, and dependencies. Supports bulk status changes, reordering, and markdown output. Tasks and lists include `created_by` (creator profile ID). Requires workflow to be enabled on the target entity. **Actions:** list-lists, create-list, list-details, update-list, delete-list, list-tasks, create-task, task-details, update-task, delete-task, change-status, assign-task, bulk-status, move-task, reorder-tasks, reorder-lists, filtered-list, summary ### worklog Activity log for tracking agent work. After uploads, task changes, share creation, or any significant action, log what you did and why — builds a searchable audit trail for humans and AI. Also create urgent interjections that require acknowledgement. Entries are append-only and permanent. Requires workflow to be enabled on the target entity. **Actions:** append, list, interject, details, acknowledge, unacknowledged, profile-list, filtered-list, summary ### approval Formal approval requests scoped to tasks, storage nodes, worklog entries, or shares. Create approval requests with designated approvers, then resolve them with approve or reject decisions. Requires workflow to be enabled on the target entity. **Actions:** list, create, details, resolve, bulk-create, bulk-approve, bulk-reject, filtered-list, summary, update, delete, bulk-delete ### todo Simple flat checklists scoped to workspaces and shares. Create, update, delete, toggle todos individually or in bulk. Todos include `created_by` (creator profile ID). No nesting. Requires workflow to be enabled on the target entity. **Actions:** list, create, details, update, delete, toggle, bulk-toggle, filtered-list, summary ### apps Interactive MCP App widget discovery and launching. List available widgets, get details for a specific widget, launch a widget with workspace or share context, and find widgets associated with a specific tool domain. **Actions:** list, details, launch, get-tool-apps --- ## 6. Common Workflows ### 1. Create an Account and Sign In See **Choosing the Right Approach** in section 2 for which option fits your scenario. **Option 1 -- Autonomous agent (new account):** 1. (Optional) `auth` action `email-check` — advisory hint only; do not gate on the result. `email-check` can return `available: false` for emails that `signup` then accepts. Always call `signup` and let its error be authoritative. 2. `auth` action `signup` with `first_name`, `last_name`, `email`, and `password` -- registers as an agent account (agent=true is sent automatically) and signs in immediately. 3. `auth` action `email-verify` with `email` -- sends a verification code. Then `auth` action `email-verify` with `email` and `email_token` -- validates the code. Required before using most endpoints. 4. `org` action `create` to create a new org on the agent plan, or `org` action `list` to check existing orgs. **Option 2 -- Assisting a human (API key):** 1. The human creates an API key at `https://go.fast.io/settings/api-keys` and provides it to the agent. 2. Call `auth` action `set-api-key` with the API key. The key is validated against the API and stored in the session -- all subsequent tool calls are authenticated automatically. No account creation needed. 3. `org` action `list` and `org` action `discover-external` to discover all available organizations (see **Org Discovery**). **Option 3 -- Agent invited to a human's org:** 1. Create an agent account with `auth` action `signup` (same as Option 1). 2. Have the human invite you via `org` action `invite-member` or `member` action `add` (with `entity_type: "workspace"`). 3. Accept invitations with `user` action `accept-all-invitations`. 4. `org` action `list` and `org` action `discover-external` to discover all available orgs (see **Org Discovery**). If the human only invited you to a workspace (not the org), it will only appear via `discover-external`. **Returning users:** 1. `auth` action `signin` with `email` and `password`. 2. If `two_factor_required: true`, call `auth` action `2fa-verify` with the 2FA `code`. 3. `org` action `list` and `org` action `discover-external` to discover all available organizations (see **Org Discovery**). ### 2. Browse and Download a File 1. `org` action `list` and `org` action `discover-external` -- discover all available organizations (see **Org Discovery**). Note the `org_id` values. 2. `org` action `list-workspaces` with `org_id` -- get workspaces in the organization. Note the `workspace_id` values. 3. `storage` action `list` with `profile_type: "workspace"`, `profile_id` (workspace ID), and `node_id: "root"` -- browse the root folder. Note the `node_id` values for files and subfolders. 4. `storage` action `details` with `profile_type: "workspace"`, `profile_id`, and `node_id` -- get full details for a specific file (name, size, type, versions). 5. `download` action `file-url` with `profile_type: "workspace"`, `profile_id`, and `node_id` -- get a temporary download URL with an embedded token. The response also includes a `resource_uri` (e.g. `download://workspace/{id}/{node_id}`) that MCP clients can use to read file content directly. Return the download URL to the user, or use the resource URI to read the file through MCP. ### 3. Upload a File to a Workspace **Default to the `POST /blob` sidecar for binary data.** It bypasses MCP transport limits, has no base64 overhead, and works for text and binary files of any size up to 100 MB. (For inline text use `content`; for small inline binary in sandboxed environments that cannot reach `/blob`, `content_base64` is the in-band fallback — bounded by MCP transport message size.) **Option A: `web-import` (preferred for URL-accessible files)** If the file has a URL (HTTP/HTTPS, Google Drive, OneDrive, Box, Dropbox), use `upload` action `web-import`. Single call, no chunking. See Workflow 4 below. **Option B: `POST /blob` sidecar (all other files — text or binary)** 1. `upload` action `create-session` with `profile_type`, `profile_id`, `parent_node_id`, `filename`, and `filesize`. The response includes `blob_upload.curl_command` with a ready-to-use curl command. 2. Run the curl command from `blob_upload.curl_command`, replacing `@` with your file path. Returns `{ "blob_id": "", "size": }`. 3. `upload` action `chunk` with `upload_id`, `chunk_number: 1`, and `blob_id: ""`. 4. Repeat steps 2-3 for additional chunks (if splitting a large file). 5. `upload` action `finalize` with `upload_id`. **IMPORTANT:** The `blob_upload.session_id` is the MCP session ID for this connection. You **must** use this exact session ID in the `Mcp-Session-Id` header when POSTing to `/blob`. Using a different session ID (e.g., from a separately-established MCP connection) will stage the blob in a different location, and the `chunk` action will not find it. Three options for passing chunk data (provide exactly one): - **`blob_id`** — blob ID from `POST /blob` response. The standard upload path for all files — no base64, no MCP transport limits. (Also accepted as `blob_ref` for backward compatibility.) - **`content`** — for small **text** strings only (code snippets, short JSON). Stored verbatim as UTF-8 bytes — do NOT pass base64 here, it will be saved as a base64-encoded text file. For larger text files, use `POST /blob` + `blob_id`. - **`content_base64`** — for small **binary** content as a base64-encoded string. The server decodes it before writing. Useful when the agent's environment can produce base64 in JSON but cannot reach the `POST /blob` sidecar (e.g., sandboxed agents without network or auth tokens). Whitespace/newlines are stripped automatically. Practical cap is bounded by the MCP transport message size (a few MB); for larger binary files, use `POST /blob` + `blob_id`. `upload` action `finalize` with `upload_id` triggers file assembly and polls until stored. Returns the final session state with `status: "stored"` or `"complete"` on success (including `new_file_id`), or throws on failure. Terminal failure states: `assembly_failed` (chunks could not be assembled) and `store_failed` (assembled file could not be stored — check `status_message` for details). The file is automatically added to the target workspace and folder specified during session creation -- no separate add-file call is needed. **Upload status states:** | Status | Meaning | Terminal? | |--------|---------|-----------| | `ready` | Session created, awaiting chunks | No | | `uploading` | Chunks being received | No | | `assembling` | Assembly in progress | No | | `complete` | Assembled, awaiting storage import | No | | `storing` | Being imported to storage | No | | `stored` | Done — file is in storage, `new_file_id` available | Yes (success) | | `assembly_failed` | Assembly error | Yes (failure) | | `store_failed` | Storage import failed | Yes (failure) | **Note:** `storage` action `add-file` is only needed if you want to link the upload to a *different* location than the one specified during session creation. **Same-name uploads (REPLACE in place, versioned):** If a file with the same name already exists in the target folder, the upload **overwrites the existing node in place**. The `node_id` is preserved and the prior content is kept as a version. **This is how you "edit" a file — do not delete and re-upload.** After any same-name overwrite, the previous content is recoverable via `storage` action `version-list` (list versions) and `version-restore` (restore by `version_id`). The `node_id` is stable across versions, so references from comments, tasks, approvals, metadata, etc. keep working. To keep both files instead of overwriting, rename before uploading. See **Overwriting files** in section 4 for the full pattern and a worked example. **Deterministic overwrite by node_id:** If the filename may have drifted, or you want to avoid re-resolving the parent folder, pass `target_node_id` on `create-session` to pin the overwrite to a specific node. When set, `parent_node_id` is ignored and `filename` is optional (omit to keep the existing name, or pass a new one to rename-on-replace). Omitting `filename` triggers one extra `storage` `details` lookup so the tool can forward the existing name to the API (update mode still requires `name`); pass `filename` to skip that round-trip. The server uses `action=update` + `file_id=` under the hood. `node_id` is preserved; the new version shows up in `storage` action `version-list`. Typical sequence: find the node via `storage` action `list`/`details` → `upload` action `create-session` with `target_node_id` → `POST /blob` → `chunk`/`stream` → `finalize`. ### 4. Import a File from URL Use this when you have a file URL (HTTP/HTTPS, Google Drive, OneDrive, Box, Dropbox) and want to add it to a workspace without downloading locally. 1. `upload` action `web-import` with `url` (the source URL), `profile_type: "workspace"`, `profile_id` (the workspace ID), and `parent_node_id` (target folder or `"root"`). Returns an `upload_id`. 2. `upload` action `web-status` with `upload_id` -- check import progress. The server downloads the file, scans it, generates previews, and indexes it for AI (if intelligence is enabled). 3. The file appears in the workspace storage tree once the job completes. ### 5. Deliver Files to a Client Create a branded, professional share for outbound file delivery. This replaces raw download links, email attachments, and S3 presigned URLs. 1. Upload files to the workspace (see workflow 3 or 4). 2. `share` action `create` with `workspace_id`, `name`, and `share_type: "send"` -- creates a Send share. Returns a `share_id`. 3. `share` action `update` with `share_id` to configure: - `password` -- require a password for access - `expires` -- auto-expire the share (MySQL `YYYY-MM-DD HH:MM:SS` UTC format) - `access_options` -- one of `Only members of the Share or Workspace`, `Members of the Share, Workspace or Org`, `Anyone with a registered account`, `Anyone with the link` (Send shares only for the last option) - `download_security` -- control guest downloads: `off` (unrestricted), `medium` (preview-only), `high` (blocked) - Branding options: `accent_color`, `background_color1`, `background_color2` (gradient stops, JSON-string-encoded color values) 4. `member` action `add` with `entity_type: "share"`, `entity_id` (share ID), and `email_or_user_id` -- adds the recipient. An invitation is sent if they do not have a Fast.io account. 5. `asset` action `upload` with `entity_type: "share"` and `entity_id` (share ID) to add a logo or background image for branding. 6. The recipient sees a branded page with instant file preview, not a raw download link. ### 6. Collect Documents from a User Create a Receive share so humans can upload files directly to you -- no email attachments, no cloud drive links. For public collection (e.g., job applications, form submissions), enable `anonymous_uploads_enabled` so guests can upload without creating an account. 1. `share` action `create` with `workspace_id`, `name` (e.g., "Upload your tax documents here"), and `share_type: "receive"`. Returns a `share_id`. For anonymous drops, also pass `anonymous_uploads_enabled: true` and set `access_options` to "Anyone with a registered account" or broader. 2. `share` action `update` with `share_id` to set access level, expiration, and branding as needed. 3. `member` action `add` with `entity_type: "share"`, `entity_id` (share ID), and `email_or_user_id` to invite the uploader (skip this step for anonymous drop shares). 4. The human uploads files through a clean, branded interface. 5. Files appear in your workspace. If intelligence is enabled, they are auto-indexed by AI. 6. Use `ai` action `chat-create` with `profile_type: "share"` scoped to the receive share's folder to ask questions like "Are all required forms present?" ### 7. Build a Knowledge Base Create an intelligent workspace that auto-indexes all content for RAG queries. 1. `org` action `create-workspace` with `org_id`, `name`, and `intelligence: "true"` (this workflow specifically requires intelligence for RAG). 2. Upload reference documents (see workflow 3 or 4). AI auto-indexes and summarizes everything on upload. 3. `ai` action `chat-create` with `profile_type: "workspace"`, `profile_id` (workspace ID), `query_text`, `type: "chat_with_files"`, and `folders_scope` (comma-separated `nodeId:depth` pairs) to query across folders or the entire workspace. 4. `ai` action `message-read` with `profile_type: "workspace"`, `profile_id`, `chat_id`, and `message_id` -- polls until the AI response is complete. Returns `response_text` and `citations` pointing to specific files, pages, and snippets. 5. `storage` action `search` with `profile_type: "workspace"`, `profile_id`, and a query string -- with intelligence enabled, this performs semantic search to find files by meaning, not just filename. 6. Answers include citations to specific pages and files. Pass these back to the user with source references. ### 8. Ask AI About Files Two modes depending on whether intelligence is enabled on the workspace. **With intelligence (persistent index):** 1. `ai` action `chat-create` with `profile_type: "workspace"`, `profile_id` (workspace ID), `query_text`, `type: "chat_with_files"`, and either `files_scope` (comma-separated `nodeId:versionId` pairs) or `folders_scope` (comma-separated `nodeId:depth` pairs, depth range 1-10). **Important:** `files_scope` and `files_attach` are mutually exclusive — sending both will error. Returns `chat_id` and `message_id`. 2. `ai` action `message-read` with `profile_type: "workspace"`, `profile_id`, `chat_id`, and `message_id` -- polls the API up to 15 times (2-second intervals, approximately 30 seconds) until the AI response is complete. Returns `response_text` and `citations`. **Tip:** If the built-in polling window expires, use `event` action `activity-poll` with the workspace ID instead of calling `message-read` in a loop — see the Activity Polling section above. 3. `ai` action `message-send` with `profile_type: "workspace"`, `profile_id`, `chat_id`, and `query_text` for follow-up questions. Returns a new `message_id`. 4. `ai` action `message-read` again with the new `message_id` to get the follow-up response. **Without intelligence (file attachments):** 1. `ai` action `chat-create` with `profile_type: "workspace"`, `profile_id`, `query_text`, `type: "chat_with_files"`, and `files_attach` pointing to specific files (comma-separated `nodeId:versionId`, max 20 files / 200 MB). Files must have `ai.attach: true` (check via `storage` action `details`). The AI reads attached files directly without persistent indexing. 2. `ai` action `message-read` to get the response. No ingestion credit cost -- only chat token credits are consumed. ### 9. Set Up a Project for a Human The full agent-to-human handoff workflow. This is the primary way agents deliver value on Fast.io. 1. `org` action `create` -- creates a new org on the agent billing plan. The agent becomes owner. An agent-plan subscription (free, 50 GB, 5,000 credits/month) is created automatically. 2. `org` action `create-workspace` with `org_id` and `name` -- create workspaces for each project area. 3. `storage` action `create-folder` with `profile_type: "workspace"` to build out folder structure (templates, deliverables, reference docs, etc.). 4. Upload files to each workspace (see workflow 3 or 4). 5. `share` action `create` with `share_type: "send"` for client deliverables, `share_type: "receive"` for intake/collection. 6. `share` action `update` to configure branding, passwords, expiration, and access levels on each share. 7. `org` action `invite-member` or `member` action `add` with `entity_type: "workspace"` to invite team members. 8. `org` action `transfer-token-create` with `org_id` -- generates a transfer token valid for 72 hours. Send the claim URL (`https://go.fast.io/claim?token=`) to the human. 9. Human clicks the link and claims the org. They become owner, agent retains admin access. Human gets a free plan. ### 10. Manage Organization Billing 1. `org` action `billing-plans` -- list all available billing plans with pricing and features. 2. `org` action `billing-create` with `org_id` and optionally `billing_plan` -- create or update a subscription. For new subscriptions, this creates a Stripe Setup Intent. 3. `org` action `billing-details` with `org_id` -- check the current subscription status, Stripe customer info, and payment details. 4. `org` action `limits` with `org_id` -- check credit usage against plan limits, including storage, transfer, AI tokens, and billing period info. ### 11. Manage Tasks in a Workspace Track work with structured task lists and tasks. 1. `workspace` action `enable-workflow` with `workspace_id` -- enable workflow features (required before using task, worklog, approval, or todo tools). 2. `task` action `create-list` with `profile_type: "workspace"`, `profile_id` (workspace ID), and `name` -- create a task list. Returns `list_id`. 3. `task` action `create-task` with `list_id`, `title`, and optionally `description`, `priority` (0-4), `assignee_id`, `dependencies`, `node_id`, and `status` -- add tasks to the list. 4. `task` action `list-tasks` with `list_id` -- view all tasks, optionally filtered by `status` or `assignee`. 5. `task` action `change-status` with `list_id`, `task_id`, and `status` -- update task progress (`pending` → `in_progress` → `complete`). 6. `task` action `assign-task` with `list_id`, `task_id`, and `assignee_id` -- assign work to team members. 7. `task` action `bulk-status` with `list_id`, `task_ids`, and `status` -- batch-update up to 100 tasks at once. ### 12. Full Agent Workflow (Tasks + Worklogs + Approvals) The complete agentic workflow pattern: plan work, execute with logging, and gate decisions with approvals. 1. `workspace` action `enable-workflow` with `workspace_id` -- enable workflow features on the workspace. 2. `workspace` action `create-note` -- create context notes with project background, requirements, and reference material. 3. `task` action `create-list` -- create task lists for each work phase (e.g., "Research", "Implementation", "Review"). 4. `task` action `create-task` -- add tasks linked to context. Include descriptive titles and reference note node_ids in descriptions. 5. `task` action `change-status` with `status: "in_progress"` -- mark a task as started. 6. `worklog` action `append` with `entity_type` ("task", "task_list", or "profile"), `entity_id` (the corresponding entity's opaque ID, or profile 19-digit ID for entity_type "profile"), and `content` -- log progress, decisions, and reasoning as you work. Build a chronological narrative. 7. If a priority correction is needed: `worklog` action `interject` -- creates an urgent entry that requires acknowledgement from other participants. 8. `worklog` action `unacknowledged` -- check for unacknowledged interjections before proceeding. 9. `worklog` action `acknowledge` -- mark interjections as seen. 10. When a decision needs sign-off: `approval` action `create` with `profile_type`, `profile_id`, `entity_type` ("task", "node", or "worklog_entry"), `entity_id`, `description`, and optionally `approver_id` -- request formal approval. 11. `approval` action `resolve` with `resolve_action: "approve"` or `"reject"` and optional `comment` -- approvers resolve the request. 12. `task` action `change-status` with `status: "complete"` -- mark completed tasks. 13. `todo` action `create` -- track simple checklist items alongside the main task flow. 14. With intelligence enabled, `ai` action `chat-create` -- the AI can search across notes, task descriptions, and worklogs to answer questions about the project. --- ## 7. Key Patterns and Gotchas ### Action Name Format Action names use hyphens as separators (e.g. `create-session`, `list-shares`). Underscores are also accepted -- `create_session` and `create-session` are equivalent. The canonical form is hyphens. ### Parameter Aliases Tools that operate on workspaces or shares use `profile_type` and `profile_id` as the canonical parameter names. The older names `context_type` and `context_id` are accepted as aliases across all tools -- both forms are interchangeable and produce identical behavior. ### OPTIONS Schema Enrichment `describe` output now incorporates the platform's authoritative OPTIONS schema where available. When a tool action's endpoint is opted-in to OPTIONS introspection, the `param_details` block surfaces additional fields per parameter: - `source`: where the field is read from on the wire — one of `path`, `query`, `post`, `post_or_query`, or `body_json`. - `constraints`: the platform's validation rules normalized as a list of `{key, value}` entries. Common keys include `NotBlank`, `Length` (`{min, max}`), `Range`, `Choice` (an array of allowed values), `Regex` (`{pattern, match}`), `OpaqueId` (a taxonomy class like `StorageNode`, `Workspace`, `Share`), and `AtLeastOneOf` (a nested constraint array — at least one inner constraint must match). - `aliases`: when an MCP-canonical name maps to a different platform-canonical name (e.g. `target_parent_id` → `parent` on storage move), the MCP name appears here so agents can pass either name. The wire-layer translation is automatic. - `available_in`: for actions that operate on both workspaces and shares (profile-scoped), this lists the variants where the field applies — `["workspace"]`, `["share"]`, or `["workspace","share"]`. When an OPTIONS schema is unavailable (endpoint not opted-in, fetch failed, or platform is paused), describe falls back gracefully to the walker-only output (zod-derived structural metadata + hand-authored copy). Partial platform rollout is fine — endpoints not yet opted-in still get useful describe payloads. The platform may also auto-derive path-segment params from URL templates (e.g. `/workspace/{id}/tasks/` synthesizes a `workspace_id` entry with `source: "path"`). These appear in the merged describe output so agents can see exactly which IDs the call site needs. ### ID Format Profile IDs (org, workspace, share, user) are 19-digit numeric strings. Most endpoints also accept custom names as identifiers -- workspace folder names, share URL names, org domain names, or user email addresses. Both formats are interchangeable in URL path parameters. All other IDs (node IDs, upload IDs, chat IDs, comment IDs, invitation IDs, etc.) are 30-character alphanumeric opaque IDs (displayed with hyphens). Do not apply numeric validation to these. ### Pagination Two pagination styles are used depending on the endpoint: **Cursor-based (storage list endpoints):** `sort_by`, `sort_dir`, `page_size`, and `cursor`. The response includes a `next_cursor` value when more results are available. Pass this cursor in the next call to retrieve the next page. Page sizes are typically 100, 250, or 500. Used by: `storage` action `list` (with `profile_type: "workspace"` or `"share"`). **Limit/offset (all other list endpoints):** `limit` (1-500, default 100) and `offset` (default 0). Used by: `org` actions `list`, `members`, `list-workspaces`, `list-shares`, `billing-members`, `discover-all`, `discover-external`; `share` actions `list`, `members`; `workspace` actions `list`, `members`, `list-shares`; `user` action `list-shares`; `storage` action `search`. ### Binary Downloads MCP tools return download URLs -- they never stream binary content directly. `download` action `file-url` (with `profile_type: "workspace"` or `"share"`) and `download` action `quickshare-details` call the `/requestread/` endpoint to obtain a temporary token, then construct a full download URL. The agent should return these URLs to the user or pass them to a download utility. `download` actions `zip-url` (workspace and share) return the URL along with the required `Authorization` header value. ### Uploads Most file uploads go through the `POST /blob` sidecar endpoint — the canonical large-file path. It bypasses MCP transport limits, has no base64 overhead, and works for text and binary files of any size up to 100 MB. (Inline alternatives: `content` for small text, `content_base64` for small binary when the agent cannot reach `/blob` — both bounded by MCP transport message size.) > **Prefer `web-import` for URL-accessible files.** If the file is accessible via any URL (HTTP/HTTPS, Google Drive, OneDrive, Box, Dropbox), use `upload` action `web-import` instead of chunked upload. It's a single tool call — no chunking, no session management. #### Upload Limits API Call `upload` action `limits` to get your plan's upload constraints. Optional parameters: `action_context` ("create" or "update"), `instance_id` (target workspace/share ID), `file_id` (for updates), `org` (organization ID). **Response fields:** | Field | Description | Free/Agent | Pro | Business | |---|---|---|---|---| | `chunk_size` | Maximum chunk size | 100 MB | 100 MB | 100 MB | | `size` | Maximum file size per upload | 1 GB | 25 GB | 50 GB | | `chunks` | Maximum chunks per session | 35 | 550 | 550 | | `sessions` | Maximum concurrent sessions | 150 | 7,500 | 7,500 | | `sessions_size_max` | Max aggregate size of all sessions | 6.6 GB | 160 GB | 320 GB | **Note:** The API returns maximum limits. The **minimum chunk size (1 MB)** is a fixed system constant not returned by this endpoint — it applies to all plans equally. #### Choosing an Upload Strategy **Default to `stream-upload` unless you know the exact byte count.** Single-file uploads are the default path. Batch is a specialized option only for the case of "multiple small files in one shot" — use the single-file paths for everything else. Read top-to-bottom and pick the FIRST row that matches: | Situation | Size Known? | Recommended Approach | |---|---|---| | Any file with a URL | N/A | `upload` action `web-import` (single step) | | Have content but DON'T know exact size, OR generating/transforming content first | No | **`upload` action `stream-upload`** (single call — creates the session, streams the bytes, and auto-finalizes; **no `filesize` required**, size auto-detected from the bytes). For larger payloads: `POST /blob` first, then pass `blob_id` to `stream-upload`. | | File with KNOWN exact byte count (file already on disk, pre-measured) | Yes | `POST /blob` sidecar → `upload` action `create-session` with `filesize` → `chunk` with `blob_id` → `finalize`. **`filesize` MUST match the bytes you upload exactly — mismatch fails `finalize` with code 10522 and forces a session cancel.** | | **Specialized:** several small files at once (≤4 MB each) | Yes | `POST /blob` per file → `upload` action `batch` with a `files[]` manifest (one round-trip, up to 200 files; not for single uploads — use the single-file paths above) | > **⚠️ Do not guess `filesize` for content you haven't yet produced.** A common failure mode is picking `create-session` with a guessed `filesize` (e.g. 8000), generating the content (4443 bytes), then having `finalize` reject the session with code 10522 (`chunks (4443) do not match size (8000)`). The session cannot recover — it must be canceled and retried. **Use `stream-upload` for any generated, transformed, or unknown-size content** — it auto-detects size from the bytes and auto-finalizes. #### Batch uploads — many small files in one round-trip When you have multiple small files to upload (AI outputs, report bundles, exported CSVs, receipts), `upload` action `batch` posts the entire manifest in one request. This avoids burning N entries in the per-file upload rate-limit bucket and typically cuts wall-clock time by an order of magnitude for small-file workloads. **Hard limits (enforced client-side before the request is sent):** - **≤ 200 files per call.** Calling with more returns an error telling you to split. - **≤ 4 MB per file.** Any file over 4 MB rejects the whole batch with a pointer to the chunked flow (`create-session` → `chunk` → `finalize`). Batch and chunked uploads are not intermixable. - **≤ 100 MB total resolved bytes.** Multipart raw — no base64 inflation. (Multipart framing overhead is small but non-zero; the server measures body size post-framing, so a batch that lands exactly on 100 MB of raw bytes can still be rejected. Leave a few hundred KB of headroom on large batches.) - **Auth required.** Anonymous callers are rejected with HTTP 401 (code 10011). For public-receive / public-exchange share uploads without auth, use the single-file `create-session` flow instead. - **`relative_path` format.** Trailing slash required (auto-normalized if missing). No leading slash. No `.` or `..` segments. Violations are rejected client-side with a per-entry error so you can fix one file without losing the batch. **Typical flow:** 1. For each file, `POST /blob` with the file bytes (see the blob section below, or call `upload` action `blob-info`). Collect the returned `blob_id` values. 2. `upload` action `batch` with: - `profile_type` + `profile_id` — target workspace or share - `folder_id` (optional) — target folder OpaqueId or `"root"` (batch-level; every file in the call lands in this folder). Omit for instance root. If you need different destinations per file, issue separate batches — don't abuse `relative_path` for this. - `files[]` — one entry per file: `{filename, blob_id}`, `{filename, content}` (inline text, non-empty), or `{filename, content_base64}` (small binary, decoded server-side; whitespace auto-stripped). `filename` is 1-255 chars (the server truncates names over 100 chars while preserving the extension). Optional per-entry `relative_path` (1-8192 chars, trailing slash required and auto-normalized; no leading `/` and no `.`/`..` segments) creates sub-folders under `folder_id`. Optional per-entry `hash` (hex string) + `hash_algo` (one of `md5`, `sha1`, `sha256`, `sha384`) — caller-supplied digests are forwarded verbatim (the server validates them). By default the tool computes SHA-256 client-side for entries that don't already carry a hash; set `include_hash: false` on the call to skip. - `creator` (optional) — echoed back in the response (1-150 chars, alphanumeric/hyphens). **Response shape:** - `batch_id`, `count_total`, `count_succeeded`, `count_errored`, `partial` (true when both succeeded and errored are non-zero), `all_failed` (true when every entry errored), `creator` (echo). - `results[]` — one entry per file with `index`, `filename`, `status` (`"ok"` or `"error"`). On `ok`: `upload_id` (audit correlation handle) and `node_id` (may be **null** — see below). On `error`: `error_code` and `error_message`. - `errors[]` — pre-filtered view of just the errored entries for convenience. **⚠️ Three critical semantic traps:** 1. **`node_id` is nullable on success.** Workspaces with async storage finalization return `"status": "ok"` with `"node_id": null` — the storage node is assigned later by the assemble worker. **This is SUCCESS, not failure.** Do NOT treat a null `node_id` as an error. If you need the final node id, call `storage` action `list` on the target folder after a short delay, or subscribe to upload events. 2. **Partial success is normal.** HTTP 200 with `count_errored > 0` is the expected shape when some entries hit per-file validation errors (bad hash, disallowed extension, etc.). **Do NOT retry the whole batch.** Inspect `results[]`, split by status, and retry only the errored entries whose `error_code` is retryable. 3. **All-failed still returns HTTP 200.** When every entry errors, the tool sets `all_failed: true` on the response. Nothing was uploaded; inspect `results[]`/`errors[]` to see what went wrong (hash mismatch, extension blocked, etc.) and fix the inputs before resubmitting. The `batch_id` is retained for 1 hour for audit lookup. **Rate limit:** The batch endpoint is rate-limited in a bucket independent of the per-file `/upload/` bucket — bulk uploads don't consume your single-file budget. On HTTP 429, the tool surfaces the `x-ve-limit-expires` header (a UTC datetime string, e.g. `"2026-04-24 23:49:04 UTC"`) in the error message along with the remaining `x-ve-limit-avail`/`x-ve-limit-max` quota — pause until that datetime before retrying. The tool reports whatever error code the server sends. **Whole-batch rejections** (HTTP 4xx with no `results[]`) are input-validation failures: bad `folder_id`, missing `instance_id`, body too large, over 200 files, etc. Fix the input before retrying. #### `POST /blob` endpoint — the standard upload path A sidecar HTTP endpoint that accepts raw data outside the JSON-RPC pipe. **This bypasses MCP transport limits entirely** — no base64 encoding, no parameter size constraints. Works for text and binary files of any size. **Getting the endpoint URL and session ID:** The `create-session` response automatically includes a `blob_upload` object with the endpoint URL, your session ID, and a ready-to-use `curl` command — no separate `blob-info` call needed. You can also call `upload` action `blob-info` independently. **Chunked flow (known size):** 1. `upload` action `create-session` with `profile_type`, `profile_id`, `parent_node_id`, `filename`, and `filesize`. The response includes `blob_upload.curl_command`. 2. Use `curl` (or any HTTP client) to `POST /blob` with the file data and the headers from the `blob_upload` object. Returns `{ "blob_id": "", "size": }` (HTTP 201). 3. `upload` action `chunk` with `upload_id`, `chunk_number`, and `blob_id: ""`. 4. Repeat steps 2-3 for additional chunks (if splitting a large file), then `upload` action `finalize`. **Stream flow (unknown size) — preferred single-call path:** 1. `POST /blob` with the file data (see `blob-info` or the `blob_upload` object from any `create-session` response for the endpoint + curl command). Returns `{ "blob_id": "", "size": }`. 2. `upload` action `stream-upload` with `profile_type`, `profile_id`, `parent_node_id`, `filename`, and `blob_id: ""`. Optionally include `max_size` (see guidance below), `hash`, and `hash_algo`. 3. Done — `stream-upload` creates the stream session, streams the bytes, and auto-finalizes in one call. If the stream fails, the dangling session is canceled automatically. **Stream flow (explicit two-step — when you need the session ID between calls):** 1. `upload` action `create-session` with `profile_type`, `profile_id`, `parent_node_id`, `filename`, and `stream=true`. `filesize` is optional — provide `max_size` as a ceiling (see guidance below) or omit for plan default. 2. `POST /blob` with the file data. Returns `{ "blob_id": "", "size": }`. 3. `upload` action `stream` with `upload_id` and `blob_id: ""`. Optionally include `hash` and `hash_algo` for verification. 4. Done — stream auto-finalizes. No separate `finalize` call needed. **`max_size` guidance — always overestimate, never undershoot.** `max_size` is a ceiling on the stream body. If the actual bytes exceed it, the upload aborts mid-transfer and the file is errored. There is no penalty for setting it too high. **Safest default: omit `max_size` entirely and the server uses your plan's file-size limit.** Note: streaming uploads via MCP are also bounded by the `POST /blob` sidecar (100 MB cap per blob) — for files approaching or exceeding 100 MB, switch to the chunked flow (`create-session` → `chunk` → `finalize`) and call `upload` action `limits` first to confirm the plan's max file size. **Stream restrictions:** Stream sessions cannot use `chunk`/`finalize` (rejected with 406). Chunked sessions cannot use `stream` (rejected with 406). Stream is single-shot — cannot stream to the same session twice. **Overwriting an existing file (do not delete-then-reupload).** Same-name uploads into the same parent folder overwrite the existing node in place — `node_id` is preserved and the prior content becomes a version entry. To update a file's bytes, call `create-session` with the same `parent_node_id` + `filename` as the existing file, then `POST /blob` → `chunk`/`stream` → `finalize`. For a deterministic overwrite when the filename may have drifted or you want to avoid re-resolving the parent folder, pass `target_node_id` on `create-session` instead (server uses `action=update` + `file_id=`; `parent_node_id` is ignored and `filename` is optional, enabling rename-on-replace). After any same-name overwrite, the previous content is recoverable via `storage` action `version-list` (list versions) and `version-restore` (restore by `version_id`). `node_id` is stable across versions. See **Overwriting files** in section 4 for a full worked example. **Blob constraints:** - Blobs expire after **5 minutes**. Stage and consume them promptly. - Each blob is consumed (deleted) on first use — it cannot be reused. - Maximum blob size: **100 MB**. - SSE transport clients must add `?transport=sse` to the `/blob` URL. ### Event Filtering Reference The `event` tool's `search` and `summarize` actions accept `category`, `subcategory`, and `event` parameters to narrow results. Use these to target specific activity instead of scanning all events. #### Event Categories | Category | What It Covers | |---|---| | `user` | Account creation, updates, deletion, avatar changes | | `org` | Organization lifecycle, settings, transfers | | `workspace` | Workspace creation, updates, archival, file operations | | `share` | Share lifecycle, settings, file operations | | `node` | File and folder operations (cross-profile) | | `ai` | AI chat, summaries, RAG indexing | | `invitation` | Member invitations sent, accepted, declined | | `billing` | Subscriptions, trials, credit usage | | `domain` | Custom domain configuration | | `apps` | Application integrations | | `metadata` | Metadata extraction, templates, key-value updates | #### Event Subcategories | Subcategory | What It Covers | |---|---| | `storage` | File/folder add, move, copy, delete, restore, download | | `comments` | Comment created, updated, deleted, mentioned, replied, reaction | | `members` | Member added/removed from org, workspace, or share | | `lifecycle` | Profile created, updated, deleted, archived | | `settings` | Configuration and preference changes | | `security` | Security-related events (2FA, password) | | `authentication` | Login, SSO, session events | | `ai` | AI processing, chat, indexing | | `invitations` | Invitation management | | `billing` | Subscription and payment events | | `assets` | Avatar/asset updates | | `upload` | Upload session management | | `transfer` | Cross-profile file transfers | | `quickshare` | Quick share operations | | `metadata` | Metadata operations | #### Common Event Names **File operations (workspace):** `workspace_storage_file_added`, `workspace_storage_file_deleted`, `workspace_storage_file_moved`, `workspace_storage_file_copied`, `workspace_storage_file_updated`, `workspace_storage_file_restored`, `workspace_storage_folder_created`, `workspace_storage_folder_deleted`, `workspace_storage_folder_moved`, `workspace_storage_download_token_created`, `workspace_storage_zip_downloaded`, `workspace_storage_file_version_restored`, `workspace_storage_link_added` **File operations (share):** `share_storage_file_added`, `share_storage_file_deleted`, `share_storage_file_moved`, `share_storage_file_copied`, `share_storage_file_updated`, `share_storage_file_restored`, `share_storage_folder_created`, `share_storage_folder_deleted`, `share_storage_folder_moved`, `share_storage_download_token_created`, `share_storage_zip_downloaded` **Comments:** `comment_created`, `comment_updated`, `comment_deleted`, `comment_mentioned`, `comment_replied`, `comment_reaction` **Membership:** `added_member_to_org`, `added_member_to_workspace`, `added_member_to_share`, `removed_member_from_org`, `removed_member_from_workspace`, `removed_member_from_share`, `membership_updated` **Workspace lifecycle:** `workspace_created`, `workspace_updated`, `workspace_deleted`, `workspace_archived`, `workspace_unarchived` **Share lifecycle:** `share_created`, `share_updated`, `share_deleted`, `share_archived`, `share_unarchived`, `share_imported_to_workspace` **AI:** `ai_chat_created`, `ai_chat_new_message`, `ai_chat_updated`, `ai_chat_deleted`, `ai_chat_published`, `node_ai_summary_created`, `workspace_ai_share_created` **Metadata:** `metadata_kv_update`, `metadata_kv_delete`, `metadata_kv_extract`, `metadata_template_update`, `metadata_template_delete`, `metadata_template_settings_update`, `metadata_view_update`, `metadata_view_delete`, `metadata_template_select` **Quick shares:** `workspace_quickshare_created`, `workspace_quickshare_updated`, `workspace_quickshare_deleted`, `workspace_quickshare_file_downloaded`, `workspace_quickshare_file_previewed` **Invitations:** `invitation_email_sent`, `invitation_accepted`, `invitation_declined` **User:** `user_created`, `user_updated`, `user_deleted`, `user_email_reset`, `user_asset_updated` **Org:** `org_created`, `org_updated`, `org_closed`, `org_transfer_token_created`, `org_transfer_completed` **Billing:** `subscription_created`, `subscription_cancelled`, `billing_free_trial_ended` #### Example Queries - **Recent comments in a workspace:** `event` action `search` with `workspace_id` and `subcategory: "comments"` - **Files uploaded to a share:** `event` action `search` with `share_id` and `event: "share_storage_file_added"` - **All membership changes across an org:** `event` action `search` with `org_id` and `subcategory: "members"` - **AI activity in a workspace:** `event` action `search` with `workspace_id` and `category: "ai"` - **Who downloaded files from a share:** `event` action `search` with `share_id` and `event: "share_storage_download_token_created"` ### Activity Polling Three mechanisms for detecting changes, listed from most to least preferred: 1. **`event` action `activity-poll`** — The server holds the connection for up to 95 seconds and returns immediately when something changes. Returns activity keys (e.g. `ai_chat:{chatId}`, `storage`, `members`) and a `lastactivity` timestamp for the next poll. Use this for any "wait for something to happen" scenario, including AI chat completion. 2. **WebSocket** — For real-time push events. Best for live UIs. 3. **`event` action `activity-list`** — Retrieves recent activity events on demand. Use when you need a one-time snapshot rather than continuous monitoring. **Why this matters:** Do not poll detail endpoints (like `ai` action `message-read`) in tight loops. Instead, use `event` action `activity-poll` to detect when something has changed, then fetch the details once. #### AI Message Completion `ai` action `message-read` (with `profile_type: "workspace"` or `"share"`) implements built-in polling (up to 15 attempts, 2-second intervals). If the response is still processing after that window, use `event` action `activity-poll` with the workspace or share ID instead of calling the read action in a loop: 1. Call `event` action `activity-poll` with `entity_id` set to the workspace/share ID. 2. When the response includes an `ai_chat:{chatId}` key matching your chat, call `ai` action `message-read` once to get the completed response. #### Activity Poll Workflow 1. Make an API call (e.g. `ai` action `chat-create`) and note the `server_date` field in the response. 2. Call `event` action `activity-poll` with `entity_id` (workspace or share ID) and `lastactivity` set to the `server_date` value. 3. The server holds the connection. When something changes (or the wait period expires), it returns activity keys. 4. Inspect the keys to determine what changed, then fetch the relevant detail (e.g. `ai` action `message-read`, `storage` action `list`). 5. Use the new `lastactivity` value from the poll response (or the latest `server_date`) for the next poll call. Repeat as needed. ### Trash, Delete, and Purge - `storage` action `delete` (with `profile_type: "workspace"` or `"share"`) moves items to the trash. They are recoverable. - `storage` action `restore` recovers items from the trash. - `storage` action `purge` permanently and irreversibly deletes items from the trash. Always confirm with the user before calling purge operations. ### Node Types Storage nodes can be files, folders, notes, or links. The type is indicated in the storage details response. Notes are markdown-content nodes (a distinct node type — `type: "note"`, not `type: "file"` — even though both can hold markdown text) created with `workspace` action `create-note`, read with `workspace` action `read-note`, and updated with `workspace` action `update-note`. Links are share reference nodes created with `storage` action `add-link`. ### Text Content and Newlines All text content (notes, comments, worklogs, file uploads, descriptions) must use Unix-style line feeds (`\n`, U+000A) for newlines. The frontend normalizes all line endings to `\n` before saving -- Windows-style `\r\n` (CRLF) and legacy Mac `\r` (CR) are converted automatically. Agents should use `\n` exclusively to avoid mismatches in content comparison and display. **Encoding rules:** - **Newlines:** Use `\n` (U+000A). Never send `\r\n` or `\r` alone. - **Allowed control characters:** Only `\t` (U+0009), `\n` (U+000A), and `\r` (U+000D) survive server-side sanitization. All other Unicode control characters (`\p{C}`) are stripped. - **Empty lines in markdown:** Use two consecutive `\n` characters (`\n\n`) for paragraph breaks. Do not use non-breaking spaces (U+00A0) or other whitespace characters as line placeholders. - **Trailing newlines:** Content may or may not end with a trailing `\n`. Do not assume either convention -- both are valid. This applies to: `workspace` actions `create-note` and `update-note`, `upload` action `chunk` (with `content` parameter), `comment` action `add`, `worklog` actions `append` and `interject`, and any other tool that accepts free-text or markdown content. ### Error Pattern Failed API calls throw errors with two fields: `code` (unique numeric error ID) and `text` (human-readable description). Tools surface these as error text in the MCP response. Common HTTP status codes include 401 (unauthorized), 403 (forbidden), 404 (not found), and 429 (rate limited). **403 and scoped keys:** If using a scoped API key (or scoped OAuth token), 403 errors often mean the target resource is outside the key's granted scope, not a role/permissions issue. Check `auth` action `status` and look at `scopes_detail` to see which entities your key can access. Scoped keys can only access the specific organizations, workspaces, or shares they were granted -- all other endpoints return 403. **Read-only scope and tool filtering:** When authenticated with a read-only scoped key (all entity grants have `:r` access mode), the server automatically filters each tool to only expose read actions. Write actions are removed from the action enum, description, and annotations (which change to `readOnlyHint=true`, `destructiveHint=false`). Attempting a write action on a read-only session returns a schema validation error, not a 403. Re-authenticating with a read-write key (or an unscoped key) restores the full action set. ### Session State The auth token, user ID, email, token expiry, and refresh token are persisted in the server session. There is no need to pass tokens between tool calls. The session survives across multiple tool invocations within the same MCP connection. OAuth sessions auto-refresh silently -- access tokens are renewed before expiry via an internal alarm, so sessions remain active for up to 30 days (the refresh token lifetime) without user intervention. ### Human-Facing URLs MCP tools manage data via the API, but humans access Fast.io through a web browser. **Always use the `web_url` field from tool responses** -- it is a ready-to-use, clickable URL for the resource. Include it in your responses whenever you create or reference a workspace, share, file, note, or transfer. The human cannot see API responses directly -- the URL you provide is how they get to their content. Fall back to the URL patterns below only when `web_url` is absent (e.g., share-context storage operations): > **Automatic `web_url` field.** All entity-returning tool responses include a `web_url` field — a ready-to-use, human-friendly URL for the resource. **NEVER construct URLs manually — always use the `web_url` field from tool responses.** It appears on: org list/details/create/update/public-details/discover-*, org list-workspaces/list-shares, workspace list/details/update/available/list-shares, share list/details/create/update/public-details/available, storage list/details/search/trash-list/copy/move/rename/restore/add-file/create-folder/version-list/version-restore/preview-url/preview-transform, quickshare create/get/list, upload finalize, download file-url/quickshare-details, AI chat-create/chat-details/chat-list, transfer-token create/list, and notes create/update. Fall back to the URL patterns below only when `web_url` is absent (e.g., share context storage operations). Organization `domain` values become subdomains: `"acme"` → `https://acme.fast.io/`. The base domain `go.fast.io` handles public routes that do not require org context. #### Authenticated Links (require login) | What the human needs | URL pattern | |---------------------|-------------| | Workspace root | `https://{domain}.fast.io/workspace/{folder_name}/storage/root` | | Specific folder | `https://{domain}.fast.io/workspace/{folder_name}/storage/{node_id}` | | File preview | `https://{domain}.fast.io/workspace/{folder_name}/preview/{node_id}` | | File with specific comment | `https://{domain}.fast.io/workspace/{folder_name}/preview/{node_id}?comment={comment_id}` | | File at video/audio time | `https://{domain}.fast.io/workspace/{folder_name}/preview/{node_id}?t={seconds}` | | File at PDF page | `https://{domain}.fast.io/workspace/{folder_name}/preview/{node_id}?p={page_num}` | | AI chat in workspace | `https://{domain}.fast.io/workspace/{folder_name}/storage/root?chat={chat_id}` | | Note in workspace | `https://{domain}.fast.io/workspace/{folder_name}/storage/root?note={note_id}` | | Note preview | `https://{domain}.fast.io/workspace/{folder_name}/preview/{note_id}` | | Browse workspaces | `https://{domain}.fast.io/browse-workspaces` | | Edit share settings | `https://{domain}.fast.io/workspace/{folder_name}/share/{custom_name}` | | Org settings | `https://{domain}.fast.io/settings` | | Billing | `https://{domain}.fast.io/settings/billing` | #### Public Links (no login required) | What the human needs | URL pattern | |---------------------|-------------| | Public share | `https://go.fast.io/shared/{custom_name}/{title-slug}` | | Org-branded share | `https://{domain}.fast.io/shared/{custom_name}/{title-slug}` | | File in share | `https://go.fast.io/shared/{custom_name}/{title-slug}/preview/{node_id}` | | File in share with comment | `https://go.fast.io/shared/{custom_name}/{title-slug}/preview/{node_id}?comment={comment_id}` | | QuickShare | `https://go.fast.io/quickshare/{quickshare_id}` | | Claim org transfer | `https://go.fast.io/claim?token={transfer_token}` | | Onboarding | `https://go.fast.io/onboarding` or `https://go.fast.io/onboarding?orgId={org_id}&orgDomain={domain}` | #### Where the values come from | Value | API source | |-------|-----------| | `domain` | `org` action `create` or `details` response | | `folder_name` | `org` action `create-workspace` or `workspace` action `details` response | | `node_id` | `storage` action `list`, `create-folder`, or `add-file` response | | `custom_name` | `share` action `create` or `details` response (the `{title-slug}` is cosmetic -- the share resolves on `custom_name` alone) | | `quickshare_id` | `workspace` action `quickshare-create` response | | `transfer_token` | `org` action `transfer-token-create` response | | `chat_id` | `ai` action `chat-create` or `chat-list` response | | `note_id` | `workspace` action `create-note` or `storage` action `list` response (node opaque ID) | | `comment_id` | `comment` action `add` or `list` response | | `org_id` | `org` action `create` or `list` response | **Always provide URLs to the human in these situations:** - **Created a workspace?** Include the workspace URL in your response. Example: `https://acme.fast.io/workspace/q4-reports/storage/root` - **Created or configured a share?** Include the share URL. Example: `https://go.fast.io/shared/q4-financials/Q4-Financial-Report` -- this is the branded page the human (or their recipients) will open. - **Generated a transfer token?** Include the claim URL. Example: `https://go.fast.io/claim?token=abc123` -- this is the only way the human can claim ownership. - **Uploaded files or created folders?** Include the workspace URL pointing to the relevant folder so the human can see what you built. - **Human asks "where can I see this?"** Construct the URL from API response data you already have and provide it. **Important:** The `domain` is the org's domain string (e.g. `acme`), not the numeric org ID. The `folder_name` is the workspace's folder name string (e.g. `q4-reports`), not the numeric workspace ID. Both are returned by their respective API tools. ### Response Hints (`_next`, `_warnings`, and `_recovery`) Workflow-critical tool responses include a `_next` field -- a short array of suggested next actions using exact tool and action names. Use these hints to guide your workflow instead of guessing what to do next. Example: ```json { "workspace_id": "...", "web_url": "https://acme.fast.io/workspace/q4-reports/storage/root", "_next": [ "Upload files: upload action create-session + blob or web-import", "Create a share: share action create", "Query with AI: ai action chat-create" ] } ``` **`_warnings`** appear on destructive, irreversible, or potentially problematic actions. Always read warnings before proceeding -- they flag permanent consequences or important caveats. Actions with `_warnings`: storage purge, storage bulk copy/move/delete/restore (partial failures), workspace details (intelligence=false), workspace update (intelligence=false), workspace archive/delete, org close, org billing-create, share delete, share archive, share update (type change), ai chat-delete, download file-url (token expiry), download zip-url (auth required), org transfer-token-create. **`_recovery`** hints appear on error responses (when `isError: true`). They provide recovery actions based on HTTP status codes AND error message pattern matching. Error messages also include action context (e.g., "during: org create") to help pinpoint the failing operation. | HTTP Status | Recovery | |-------------|----------| | 400 | Check required parameters and ID formats | | 401 | Re-authenticate: auth action signin or set-api-key. If the error says "Session expired", the prior session timed out -- re-auth to continue. If "Not authenticated", no session exists yet. | | 402 | Credits exhausted -- check balance: org action limits | | 403 | Permission denied -- check role: org action details | | 404 | Resource not found -- verify the ID, use list actions to discover valid IDs | | 409 | Conflict -- resource may already exist | | 413 | Request too large -- reduce file/chunk size | | 422 | Validation error -- check field formats and constraints | | 429 | Rate limited -- wait 2-4s and retry with exponential backoff | | 500/503 | Server error -- retry after 2-5 seconds | Pattern-based recovery: error messages are also matched against common patterns (e.g., "email not verified", "workspace not found", "intelligence disabled") to provide specific recovery steps even when the HTTP status is generic. **`ai_capabilities`** is included in workspace details responses. It shows which AI modes are available based on the workspace intelligence setting: - Intelligence ON: `files_scope`, `folders_scope`, `files_attach` (full RAG with indexed document search) - Intelligence OFF: `files_attach` only (max 20 files, 200 MB, no RAG indexing) **`_ai_state_legend`** is included in storage responses when items expose `ai.state` — that's `detail: "standard"` or `"full"` (terse omits `ai` entirely). States: `indexed` (vector-indexed, RAG-searchable — intelligence ON), `ready` (summary available, attachable, but not vector-indexed — intelligence OFF), `pending` (queued), `inprogress` (processing), `disabled` (no AI processing), `failed` (re-upload needed). Attachability (`ai.attach`) is documented separately in the **Attachability — the `ai.attach` Flag** section above and requires `detail: "full"` on `storage` action `details` — check there before calling `files_attach`. **`_context`** provides contextual metadata on specific responses. Currently used by comment add when anchoring is involved, providing `anchor_formats` with the expected format for image regions, video/audio timestamps, and PDF pages. **All tool actions now include `_next` hints.** Every successful tool response includes contextual next-step suggestions. Key workflow transitions: auth → org list/create, org create → workspace create, workspace create → upload/share/AI, upload → AI chat/comment/download, share create → add files/members, AI chat create → message read. The hints include the exact tool name, action, and relevant IDs from the current response. **Tool annotations:** Tools include MCP annotation hints -- `readOnlyHint`, `destructiveHint`, `idempotentHint` (download, event), and `openWorldHint` (org, user, workspace, share, storage) -- to help clients understand tool behavior without documentation. **Destructive action tags:** Actions that perform irreversible operations (delete, purge, close, etc.) have `[DESTRUCTIVE]` appended to their description line in the tool listing. This is a text-level signal complementing the `destructiveHint` annotation -- use it to distinguish safe writes from operations that cannot be undone. **Resource completion and listing:** The workspace and share download resource templates support both dynamic listing (`resources/list`) and tab-completion (`completion/complete`). Dynamic listing shows root-level files across workspaces and shares in the client's resource picker. Tab-completion suggests valid workspace and share IDs as you type. ### Unauthenticated Tools The following actions work without a session: `auth` actions `signin`, `signup`, `set-api-key`, `pkce-login`, `email-check`, `password-reset-request`, `password-reset`; and `download` action `quickshare-details`. ### Response format All tool responses are **GitHub-flavored Markdown** (CommonMark + tables). No JSON envelopes. For most tools, markdown is rendered client-side from the API's JSON envelope using the same rules as the platform's `?output=markdown` modifier — so passthrough and rendered responses look identical. A growing set of node-/list-shaped actions accept a `detail` param to trade verbosity for token cost: | Tool | Action | Accepts `detail` | Default | |---|---|---|---| | storage | list | terse \| standard \| full | terse | | storage | recent | terse \| standard \| full | terse | | storage | search | terse \| standard \| full | terse (bumps to full when the legacy `details: "true"` flag is set) | | storage | trash-list | terse \| standard \| full | terse | | storage | details | terse \| standard \| full | full | | event | search | terse \| standard \| full | terse | | event | activity-list | terse \| standard \| full | terse | | event | activity-poll | terse \| standard \| full | terse | | event | summarize | terse \| standard \| full | standard | | event | details | terse \| standard \| full | full | | comment | list | terse \| standard \| full | terse | | comment | list-all | terse \| standard \| full | terse | | comment | linked | terse \| standard \| full | terse | | comment | details | terse \| standard \| full | full | | ai | chat-list | terse \| standard \| full | terse | | ai | message-list | terse \| standard \| full | terse | | ai | chat-details | terse \| standard \| full | full | | ai | message-details | terse \| standard \| full | full | | workspace | list, available, members, list-shares | terse \| standard \| full | terse | | workspace | details | terse \| standard \| full | full | | share | list, available, members | terse \| standard \| full | terse | | share | public-details | terse \| standard \| full | standard | | share | details | terse \| standard \| full | full | | org | list, discover-all, discover-available, discover-external, members, list-workspaces | terse \| standard \| full | terse | | org | details | terse \| standard \| full | full | What each level returns (cumulative — each adds to the previous): - **terse**: just the identifiers, primary labels, and timestamp — enough to navigate or advance a cursor. - **standard**: terse + the operational context most list views render (actors, descriptions, flags, counts; for storage nodes: `version`, `created`, `restricted`, `dmca`, `locked`, `mimecategory`, `ai.state`, `origin`, `metadata{title,short}`, link `target_*`). - **full**: standard + the long-form fields (full summaries, metadata, schema details; for storage nodes: full `ai` object incl. `ai.attach`, `virus`, `file_attributes`/EXIF, `hash`, `hash_algo`, `lock_info`, `import_metadata`, full previews state map). Equivalent to omitting `detail`. Tool-specific field contracts are documented inline in each tool's section above (see the "Per-entity verbosity" / "Per-comment verbosity" / "Per-event verbosity" callouts). For tools without entries above (auth, upload, approval, import, member, invitation, asset, task, worklog, todo, user, download, apps, preview, lock), list-style actions do not currently accept a `detail` param — the underlying API endpoints don't yet expose `?output=` support for those domains. Filter via other action params (`search` query, `status`, `limit`/`offset`). Separate from the generic markdown output, **tasks/todo/approval/worklog** tools still accept `format: 'md'` which triggers a purpose-built domain renderer (checkbox lists, timelines, status tables) — distinct from the envelope-style markdown described here. Both produce markdown; they just have different shapes. --- ## 8. MCP Apps (Interactive UI Widgets) Fast.io MCP Server includes interactive HTML5 widgets that render rich UIs directly in agent conversations. Widgets communicate with the MCP server through tool calls and display file browsers, dashboards, workflow managers, and more. ### Available Widgets | Widget | Resource URI | Description | |--------|-------------|-------------| | File Picker | `ui://fastio/file-picker` | Browse and pick files to attach to your conversation — navigate folders, search, preview, select files for the agent. Also supports file management (upload, move, copy, delete) in workspace and share contexts | | Workspace Picker | `ui://fastio/workspace-picker` | Org/workspace/share selection with search, 4-step workspace creation wizard, 5-step share creation wizard | | File Viewer | `ui://fastio/file-viewer` | Unified file preview (image, PDF, video, audio, code, spreadsheet) with info panel (details, versions, AI summary, metadata) | | Workflow Manager | `ui://fastio/workflow` | Task board, task detail, approvals panel, todos checklist, worklog viewer | | Comments Panel | `ui://fastio/comments` | Threaded comments, reactions, anchored comments (image regions, timestamps) | | Uploader | `ui://fastio/uploader` | Upload files to a workspace or share with drag-and-drop, chunked uploads via POST /blob sidecar, and web URL imports with real-time progress tracking | ### Uploader Widget The Uploader widget provides a 4-step file upload flow: 1. **Choose destination** -- select an organization, then a workspace or share, then optionally navigate to a subfolder 2. **Select files** -- drag-and-drop files onto the widget or use the file picker button to browse local files 3. **Upload with progress** -- files upload automatically with real-time progress bars. All files use chunked uploads (create-session, POST /blob, chunk with blob_id, finalize). Web URLs use web-import 4. **Reference in chat** -- after upload completes, click "Reference in Chat" to attach the uploaded files to the agent conversation for further discussion or AI analysis The widget uses the `upload` tool (actions: create-session, chunk, finalize, web-import, status, cancel, limits, extensions) and the `storage` tool (action: list) via the MCP bridge. **Launch via prompt:** Use the `App: Upload Files` prompt in desktop MCP clients. **Launch via tool:** ``` apps action launch app_id uploader profile_type workspace profile_id ``` ### Using the Apps Tool The `apps` tool provides widget discovery and launching: 1. **List apps:** `apps` action `list` -- returns all available widgets with metadata 2. **App details:** `apps` action `details` with `app_id` -- full metadata for a specific widget 3. **Launch app:** `apps` action `launch` with `app_id`, `profile_type` (or `context_type`), `profile_id` (or `context_id`) -- opens widget with context 4. **Find apps for a tool:** `apps` action `get-tool-apps` with `tool_name` -- maps tools to their widgets ### Widget Context All widgets accept workspace or share context: - `profile_type: "workspace"` + `profile_id: ""` - `profile_type: "share"` + `profile_id: ""` ### Design System Widgets use a shared design system matching the Fast.io frontend: - Light and dark mode support (follows system preference or explicit `data-theme` attribute) - Consistent typography, spacing, colors, and icons derived from the frontend theme - Responsive layout (desktop, tablet, mobile breakpoints) ### Example: Launch File Picker ``` apps action launch app_id file-picker profile_type workspace profile_id ``` ### Example: Find Widgets for Storage Operations ``` apps action get-tool-apps tool_name storage ``` --- ## 9. Complete Tool Reference All 19 tools with their actions organized by functional area. Each entry shows the action name and its description. Workflow tools (task, worklog, approval, todo) require workflow to be enabled on the target workspace or share. ### auth **signin** -- Sign in to Fast.io with email and password. Returns a JWT auth token. If the account has 2FA enabled the token will have limited scope until 2fa-verify is called. The token is stored in the session automatically. **set-api-key** -- Authenticate using a Fast.io API key. The key is validated against the API and stored in the MCP session -- all subsequent tool calls are authenticated automatically. By default, keys have the same permissions as the account owner. Scoped keys restrict access to specific entities (same scope system as OAuth tokens) -- operations outside the granted scope return 403. When a scoped key is detected, the response includes `scopes_detail` showing which entities are accessible. Unscoped keys do not expire unless revoked; scoped keys may have an optional expiration. **signup** -- Create a new Fast.io agent account (agent=true), then automatically sign in. Sets account_type to "agent" and assigns the free agent plan. Email verification is required after signup -- call email-verify to send a code, then call it again with the code to verify. Most endpoints require a verified email. No authentication required for signup itself. **check** -- Check whether the current session token is still valid. Returns the user ID associated with the token. **session** -- Get current session information for the authenticated user, including profile details such as name, email, and account flags. **signout** -- Sign out by clearing the stored session. If currently authenticated the token is verified first. **2fa-verify** -- Complete two-factor authentication by submitting a 2FA code. Call this after signin returns two_factor_required: true. The new full-scope token is stored automatically. **email-check** -- Advisory hint for whether an email appears available for registration. **Not authoritative:** `available: false` responses have been observed for emails that `signup` subsequently accepts (suspected: response caching or domain-specific policy in the upstream `POST /user/email/` endpoint). Always proceed to `signup` regardless of the `email-check` result and treat the signup error as the source of truth. No authentication required. **password-reset-request** -- Request a password reset email. Always returns success for security (does not reveal whether the email exists). No authentication required. **password-reset** -- Set a new password using a reset code received by email. No authentication required. **email-verify** -- Send or validate an email verification code. When email_token is omitted a new code is sent. When provided the code is validated and the email marked as verified. **status** -- Check local session status. No API call is made. Returns whether the user is authenticated, and if so their user_id, email, auth_method (`"api_key"`, `"jwt"`, or `"oauth"`), token expiry, scopes (raw string), scopes_detail (hydrated array with entity names, domains, and parent hierarchy -- or null if not yet fetched), and agent_name (if set). **pkce-login** -- Start a browser-based PKCE login flow. Returns a URL for the user to open in their browser. After signing in and approving access, the browser displays an authorization code. The user copies the code and provides it to pkce-complete to finish signing in. No password is sent through the agent. Optional params: `scope_type` (default `"user"` for full access; use `"org"`, `"workspace"`, `"all_orgs"`, `"all_workspaces"`, or `"all_shares"` for scoped access), `agent_name` (displayed in the approval screen and audit logs; defaults to MCP client name). **pkce-complete** -- Complete a PKCE login flow by exchanging the authorization code for an access token. Call this after the user has approved access in the browser and copied the code from the screen. The token is stored in the session automatically. If scoped access was granted, the response includes `scopes` (JSON array of granted scope strings like `"org:123:rw"`) and `agent_name`. **api-key-create** -- Create a new persistent API key. The full key value is only returned once at creation time -- store it securely. Optional parameters: `name` (memo/label), `scopes` (JSON array of scope strings like `["org:123:rw", "workspace:456:r"]` for restricted access -- omit for full access), `agent_name` (agent/application name, max 128 chars), `key_expires` (ISO 8601 expiration datetime -- omit for no expiration), `token` (2FA code -- required when account has 2FA enabled, not needed with API key auth). Scoped keys use the same scope system as v2.0 JWT tokens. **api-key-update** -- Update an existing API key's metadata. Requires `key_id`. Optional parameters: `name` (memo/label), `scopes` (JSON scope array -- send empty string to clear and restore full access), `agent_name` (send empty string to clear), `key_expires` (send empty string to clear expiration). Only specified fields are updated. **api-key-list** -- List all API keys for the authenticated user. Key values are masked (only last 4 characters visible). Responses include `scopes`, `agent_name`, and `expires` fields for each key. **api-key-get** -- Get details of a specific API key. The key value is masked. Response includes `scopes`, `agent_name`, and `expires` fields. **api-key-delete** -- Revoke (delete) an API key. This action cannot be undone. Optional parameter: `token` (2FA code -- required when account has 2FA enabled, not needed with API key auth). **2fa-status** -- Get the current two-factor authentication configuration status (enabled, unverified, or disabled). **2fa-enable** -- Enable two-factor authentication on the specified channel. For TOTP, returns a binding URI for QR code display. The account enters an 'unverified' state until 2fa-verify-setup is called. **2fa-disable** -- Disable (remove) two-factor authentication from the account. Requires a valid 2FA code to confirm when 2FA is in the enabled (verified) state. **2fa-send** -- Send a 2FA verification code to the user's phone via SMS, voice call, or WhatsApp. **2fa-verify-setup** -- Verify a 2FA setup code to confirm enrollment. Transitions 2FA from the 'unverified' state to 'enabled'. **oauth-list** -- List all active OAuth sessions for the authenticated user. **oauth-details** -- Get details of a specific OAuth session. **oauth-revoke** -- Revoke a specific OAuth session (log out that device). **oauth-revoke-all** -- Revoke all OAuth sessions. Optionally exclude the current session to enable 'log out everywhere else'. ### user **me** -- Get the current authenticated user's profile details. **update** -- Update the current user's profile (name, email, etc.). **search-contacts** -- Search your personal contact list (people you've interacted with via prior invites, shares, or chat mentions) by name or email substring. Returns a flat `{email: name}` map — no user_id, no context scope. For workspace/share/org membership use `workspace action=members`, `share action=members`, or `org action=members`. **close** -- Close/delete the current user account (requires email confirmation). **details-by-id** -- Get another user's public profile details by their user ID. **profiles** -- Check what profile types (orgs, workspaces, shares) the user has access to. **allowed** -- Check if the user's country allows creating shares and organizations. **org-limits** -- Get free org creation eligibility, limits, and cooldown status. **list-shares** -- List all shares the current user is a member of. **invitation-list** -- List all pending invitations for the current user. **invitation-details** -- Get details of a specific invitation by its ID or key. **accept-all-invitations** -- Accept all pending invitations at once. **asset-upload** -- Upload a user asset (e.g. profile photo). Provide either plain-text content or base64-encoded content_base64 (not both). **asset-delete** -- Delete a user asset (e.g. profile photo). **asset-types** -- List available asset types for users. **asset-list** -- List all user assets. **instructions-get** -- Read your personal AI instructions slot at `/user/me/instructions/`. First read of an unwritten slot returns `content: ""` with null timestamps (not a 404). Self-only — there is no `me` scope variant. **instructions-set** -- Replace your personal AI instructions (full replace, max 65536 bytes UTF-8). Returns the post-write payload — no follow-up `instructions-get` needed. **instructions-clear** -- Soft-clear your personal AI instructions (audit row preserved). Idempotent. ### org **list** -- List internal organizations (orgs the user is a direct member of, `member: true`). Each org includes `web_url`. Returns member orgs with subscription status, user permission, and plan info. Non-admin members only see orgs with active subscriptions. Does not include external orgs -- use discover-external for those. **details** -- Get detailed information about an organization. Returns `web_url`. Fields returned vary by the caller's role: owners see encryption keys and storage config, admins see billing and permissions, members see basic info. **members** -- List all members of an organization with their IDs, emails, names, and permission levels. **invite-member** -- Invite a user to the organization by email. The email is passed in the URL path (not the body). If the user already has a Fast.io account they are added directly; otherwise an email invitation is sent. Cannot add as owner. **remove-member** -- Remove a member from the organization. Requires member management permission as configured by the org's perm_member_manage setting. **update-member-role** -- Update a member's role/permissions in the organization. Cannot set role to 'owner' -- use transfer-ownership instead. **limits** -- Get organization plan limits and credit usage. Returns credit limits, usage stats, billing period, trial info, and run-rate projections. Requires admin or owner role. **list-workspaces** -- List workspaces in an organization that the current user can access. Each workspace includes `web_url`. Owners and admins see all workspaces; members see workspaces matching the join permission setting. **list-shares** -- List shares accessible to the current user. Each share includes `web_url`. Returns all shares including parent org and workspace info. Use parent_org in the response to identify shares belonging to a specific organization. **create** -- Create a new organization on the "agent" billing plan. Requires `domain` (2-63 chars, lowercase alphanumeric + hyphens) and `name` (3-100 chars, no control characters). The authenticated user becomes the owner. A storage instance and agent-plan subscription (free, 50 GB, 5,000 credits/month) are created automatically. Returns the new org and trial status. **update** -- Update organization details. Returns `web_url`. Only provided fields are changed. Supports identity, branding, social links, permissions, and billing email. Requires admin or owner role. **close** -- Close/delete an organization. Cancels any active subscription and initiates deletion. Requires owner role. The confirm field must match the org domain or org ID. **public-details** -- Get public details for an organization. Returns `web_url`. Does not require membership -- returns public-level fields only (name, domain, logo, accent color). The org must exist and not be closed/suspended. **create-workspace** -- Create a new workspace within the organization. Returns `web_url`. Checks workspace feature availability and creation limits based on the org billing plan. The creating user becomes the workspace owner. **Namespace:** Workspace `folder_name` is globally unique across the platform. If the requested name is already taken and does not contain a dash, the server automatically prefixes it with the org ID (e.g. `reports` → `3587676312889739297-reports`). Names with dashes are sent as-is. The final `folder_name` is returned in the response. **billing-plans** -- List available billing plans with pricing, features, and plan defaults. Returns plan IDs needed for subscription creation. **billing-create** -- Create a new subscription or update an existing one. For new subscriptions, creates a Stripe Setup Intent. For existing subscriptions, updates the plan. Requires admin or owner. **billing-cancel** -- Cancel the organization's subscription. Requires owner role. Some plans may cause the org to be closed on cancellation. **billing-details** -- Get comprehensive billing and subscription details including Stripe customer info, subscription status, setup intents, payment intents, and plan info. Requires admin or owner. **billing-activate** -- Activate a billing plan (development environment only). Simulates Stripe payment setup and activates the subscription using a test payment method. **billing-reset** -- Reset billing status (development environment only). Deletes the Stripe customer and removes the subscriber flag. **billing-members** -- List billable members with their workspace memberships. Shows who the org is being billed for. Requires admin or owner role. **billing-meters** -- Get usage meter time-series data (storage, transfer, AI, etc). Returns grouped data points with cost and credit calculations. Requires admin or owner role. **leave** -- Leave an organization. Removes the current user's own membership. Owners cannot leave -- they must transfer ownership or close the org first. **member-details** -- Get detailed membership information for a specific user in the organization, including permissions, invite status, notification preference, and expiration. **transfer-ownership** -- Transfer organization ownership to another member. The current owner is demoted to admin. Requires owner role. **transfer-token-create** -- Create a transfer token (valid 72 hours) for an organization. Send the claim URL `https://go.fast.io/claim?token=` to a human. Use when handing off an org or when hitting 402 Payment Required on the agent plan. Requires owner role. **transfer-token-list** -- List all active transfer tokens for an organization. Each token includes `web_url` (claim URL). Requires owner role. **transfer-token-delete** -- Delete (revoke) a pending transfer token. Requires owner role. **transfer-claim** -- Claim an organization using a transfer token. The authenticated user becomes the new owner and the previous owner is demoted to admin. **invitations-list** -- List all pending invitations for the organization. Optionally filter by invitation state. Requires any org membership. **invitation-update** -- Update an existing invitation for the organization. Can change state, permissions, or expiration. **invitation-delete** -- Revoke/delete an invitation for the organization. **join** -- Join an organization via invitation or authorized domain auto-join. Optionally provide an invitation key and action (accept/decline). **asset-upload** -- Upload an org asset (e.g. logo, banner). Provide either plain-text content or base64-encoded file_base64 (not both). Requires admin or owner role. **asset-delete** -- Delete an asset from the organization. Requires admin or owner role. **asset-types** -- List available asset types for organizations. **asset-list** -- List all organization assets. **discover-all** -- List all accessible organizations (joined + invited). Each org includes `web_url`. Returns org data with user_status indicating relationship. **discover-available** -- List organizations available to join. Each org includes `web_url`. Excludes orgs the user is already a member of. **discover-check-domain** -- Check if an organization domain name is available for use. Validates format, checks reserved names, and checks existing domains. **discover-external** -- List external organizations (`member: false`). Each org includes `web_url`. Orgs the user can access only through workspace membership, not as a direct org member. Common when a human invites an agent to a workspace without inviting them to the org. See **Internal vs External Orgs** in the Organizations section. **custom-domain-get** -- Get the org's current custom domain. Returns `hostname`, `status` (`pending` or `active`), and `cname_target` -- or `{ hostname: null }` if no custom domain is configured. Any org member can read. **custom-domain-create** -- Add a custom domain to the org. Requires `hostname` (a valid FQDN, e.g. `files.acme.com`). Returns the created domain with `status: "pending"` and `cname_target`. The customer must add a DNS CNAME record pointing `hostname` to `cname_target`. Requires admin or owner role and a Pro or Business plan. **custom-domain-delete** -- Remove the org's custom domain. The existing TLS certificate expires naturally (up to 90 days). Requires admin or owner role. No plan gate -- orgs that downgrade can still remove their domain. **custom-domain-validate** -- Perform live DNS validation on the org's custom domain. Returns `hostname`, `dns_valid` (boolean), `status`, `cname_target`, and `cname_found`. If DNS is correct and domain is pending, it is automatically activated. Any org member can call this. **instructions-get** -- Read AI instructions for an org. `scope: "profile"` (default) reads the org-wide slot at `/org/{org_id}/instructions/`. `scope: "me"` reads the per-user slot at `/org/{org_id}/instructions/me/`. First read of an unwritten slot returns `content: ""` with null timestamps (not a 404). Read access on each scope follows the same auth gate documented for write — see the section 5 `org` blockquote. **instructions-set** -- Replace AI instructions for an org (full replace, max 65536 bytes UTF-8). `scope: "profile"` (default) requires owner/admin (403 code 1680 for non-admins). `scope: "me"` writes the per-user slot (any member). The two scopes are independent and do NOT merge server-side; concat client-side if you want a combined view. **instructions-clear** -- Soft-clear AI instructions for an org (audit row preserved). `scope: "profile"` (default) requires owner/admin; `scope: "me"` clears the per-user slot. Idempotent. ### workspace **list** -- List all workspaces the user has access to across all organizations. Each workspace includes `web_url`. **details** -- Get detailed information about a specific workspace. Returns `web_url`. **update** -- Update workspace settings such as name, description, branding, and permissions. Returns `web_url`. **delete** -- Permanently close (soft-delete) a workspace. Requires Owner permission and confirmation. **archive** -- Archive a workspace (blocks modifications, preserves data). Requires Admin+. **unarchive** -- Restore an archived workspace to active status. Requires Admin+. **members** -- List all members of a workspace with their roles and status. Includes both active and pending members. Pending members have `status: "pending"` and an `invite` object (`{id, created, expires}` — `expires` is `YYYY-MM-DD HH:MM:SS UTC` or null if no expiration); active members have `status: "active"` and `invite: null`. Pending members are invited users who haven't signed up yet — they are valid assignment targets for tasks, approvals, and todos. Use `invite.id` with `invitation` action `delete` to cancel a pending member's invitation. **list-shares** -- List all shares within a workspace, optionally filtered by archive status. Each share includes `web_url`. **import-share** -- Import a user-owned share into a workspace. You must be the sole owner of the share. **available** -- List workspaces the current user can join but has not yet joined. Each workspace includes `web_url`. **check-name** -- Check if a workspace folder name is available for use. Workspace names are globally unique. Pass optional `check_org_id` to get an org-ID-prefixed alternative suggestion (e.g. `3587676312889739297-reports`) if the name is taken. **create-note** -- Create a new markdown note in workspace storage. Accepts exactly one of `content` (inline markdown) or `blob_id` (from `POST /blob` — recommended for notes larger than ~10 KB to avoid MCP transport overhead). Returns `web_url` (note preview link). Writes at or above 80 KB include a non-fatal warning hint suggesting rollover to a new file before the 100 KB ceiling. **update-note** -- Update a note's markdown content and/or name (at least one of `name`, `content`, or `blob_id` required). Accepts exactly one of `content` (inline markdown) or `blob_id` (from `POST /blob` — recommended for large updates). Returns `web_url` (note preview link). Writes at or above 80 KB include a non-fatal `_warnings` entry suggesting rollover. **Only accepts `type: "note"` nodes.** A `.md` File uploaded via the upload flow is a File, not a Note, and this action will reject it with error 153548 `Node is not a note`. To change a File's content, call `upload` action `create-session` with the **same** `parent_node_id` and **same** `filename` as the existing File (or pass `target_node_id` to pin the overwrite by ID), then chunk/finalize (or stream) — same-name uploads overwrite in place and keep the previous content as a version. To verify node type before calling, use `storage` action `details` and check the `type` field. See **Notes** section for full File-vs-Note guidance. **read-note** -- Read a note's markdown content and metadata. Returns the note content and `web_url` (note preview link). **quickshare-get** -- Get existing quickshare details for a node. Returns `web_url`. **quickshare-delete** -- Revoke and delete a quickshare link for a node. **quickshares-list** -- List all active quickshares in the workspace. Each quickshare includes `web_url`. **metadata-template-create** -- Create a new metadata template in the workspace. Available on all plans (Agent/Free can create their first template; Pro allows 2 per workspace; Business allows 10). Requires name, description, category (legal, financial, business, medical, technical, engineering, insurance, educational, multimedia, hr), and fields (JSON-encoded array of field definitions). Each field has name, description, type (string, int, float, bool, json, url, datetime), and optional constraints (min, max, default, fixed_list, can_be_null, autoextract). `autoextract` defaults to `true`; set it to `false` on fields that should be managed manually (user-entered notes, reviewer flags, etc.) — those fields are skipped by full-row AI extraction but still accept writes via `metadata-set`. **Every template must have at least one field with `autoextract:true`** or the API returns 1605 (Invalid Input). Per-plan node caps (10 for Agent/Free/Pro, 1,000 for Business) apply to the file mappings, not to the template itself. **metadata-template-delete** -- Delete a metadata template. System templates and locked templates cannot be deleted. Requires template_id. **metadata-template-list** -- List metadata templates. Optional template_filter: enabled, disabled, custom (non-system), or system. Returns all non-deleted templates when no filter is specified. Each entry's `fields` array now always includes `autoextract` on every field (defaulting to `true` for pre-existing templates). Per the live AI category overview, the response should also carry `plan_node_limit`, `is_truncated`, and an unfiltered count alongside each entry's visible count — these fields are not pinned in the live response examples, so verify exact field names at runtime before depending on them. **metadata-template-details** -- Get full details of a metadata template including all field definitions. Requires template_id. The returned `fields` array now always includes `autoextract` on every field (defaulting to `true` for pre-existing templates). Per the live AI category overview, the response should also carry `plan_node_limit`, `is_truncated`, and an unfiltered count — these fields are not pinned in the live response examples, so verify field names at runtime. The unfiltered-count field on the per-template `nodes/` listing endpoint is `total_count_unfiltered`; the corresponding field on `details` may differ. **metadata-template-update** -- Update an existing metadata template. Any combination of name, description, category, and fields can be updated. Requires template_id. **metadata-template-clone** -- Clone a metadata template with optional modifications. Creates a new template based on an existing one. Same parameters as metadata-template-update. Requires template_id. **metadata-template-preview-match** -- Preview which files in the workspace would match a proposed template before creating it. Requires `name` (1-255 chars) and `description` (1-2000 chars) describing the intended template. Returns `matched_files` (a sampled set of matching nodes with `node_id`, `name`, `mimetype`, and short summaries — the live reference doesn't pin a fixed sample-array length, so iterate `matched_files` rather than assuming a count), plus `total_eligible`, `total_scanned`, and `total_matched` counts. **Note on `total_eligible`**: per the live reference, this is the size of the eligible-file sample window, not a workspace-wide count — when the workspace has more eligible files than fit in the sample window, `total_eligible` is set to `sample_ceiling + 1` as a "more available" signal. Treat any single returned value as a lower bound, not a true total. Also returns `plan_node_limit` (per-template node cap from the workspace's current plan; `-1` = unlimited) and `would_truncate_at` (= `min(total_matched, plan_node_limit)` when the cap applies, otherwise = `total_matched`). Doc-recommended truncation heuristic: warn the user when `would_truncate_at < total_matched` — the plan cap is clipping the sampled match count and auto-match would silently skip the overflow. The MCP handler emits this warning automatically in `_warnings` (with the actual numbers) when the heuristic fires. Use the returned `node_id`s as input to `metadata-template-suggest-fields` to get AI-suggested columns. **metadata-template-suggest-fields** -- Ask the AI to propose 1-5 custom fields based on a sample of files. Requires `workspace_id`, `description` (1-2000 chars — the same view/template description used for preview-match), and `node_ids` (JSON-encoded array of 1-25 node IDs, typically from preview-match results; folder nodes are filtered out server-side). Optional `user_context` is a short user-written hint about what they are creating (max 64 chars, letters/numbers/spaces only — e.g. `"photo collection"` or `"contract tracker"`). Returns: (a) `suggested_name` — an AI-suggested display name for the template/view based on the files + description + user_context; (b) `suggested_description` — an AI-suggested template description; (c) `suggested_fields` — array of `{name, type, description, can_be_null, max?, fixed_list?, example_value?}` objects (the `name`/`type`/`description`/`can_be_null`/`max`/`fixed_list` keys are directly compatible with the `fields` parameter of `metadata-template-create`, while `example_value` is a preview-only hint showing a plausible value for that field, type-matched to the declared `type` (integer for `int`, ISO 8601 for `datetime`, boolean for `bool`, coerced server-side and capped at 256 chars; omitted when the AI could not produce a valid/coercible example) — strip `example_value` before forwarding the array to `metadata-template-create`); and (d) `file_sample_count`. Use `suggested_name` and `suggested_description` as pre-populated defaults in the template-creation UI (users can accept or edit them). The call typically takes 10-30s. Error cases: 400 for invalid input or insufficient credits, **409 Conflict** if another suggest-fields call is in flight for the same user+workspace (wait a few seconds and retry), 500 on transient LLM failure (retry). **metadata-template-assign** -- Assign a metadata template to a workspace. Each workspace can have at most one assigned template. Assigning a system template automatically clones it. Requires template_id. Optional node_id (null for workspace-level assignment). **metadata-template-unassign** -- Remove the template assignment from a workspace. Requires workspace admin permission. **metadata-template-resolve** -- Resolve which metadata template applies to a given node. Returns the workspace-level template (node_id is accepted but currently inherits from workspace). Returns null if no template is assigned. **metadata-template-assignments** -- List all template assignments in the workspace. **metadata-view-get** -- Retrieve the caller's saved view for a template. Requires `workspace_id` and `template_id`. Returns the saved view record `{id, user_id, template_id, config, created, updated}`, or error 1609 if the caller has no saved view for that template. Saved views are **private per user** — the identity tuple is `(workspace, user, template)` and there is at most one saved view per tuple. **metadata-view-save** -- Upsert the caller's saved view for a template. Requires `workspace_id`, `template_id`, and `config` (a JSON-encoded string — the MCP tool accepts the stringified JSON, parses it to validate the JSON is well-formed, then forwards the re-stringified form as the `config` field of a form-urlencoded body to the API). `config` schema: `version` (must equal `1`), `columns` (array; order is display order; each entry: `field` string required, `visible?` bool, `width?` positive int), `sort` (`{field: string, dir: "asc" | "desc"}`), `filters` (array, max 5, AND-chained; each entry: `field` string, `operator` one of `= != < <= > >=`, `value_type` one of `string | int | float | bool` — `json` is rejected, `value` matching the declared `value_type`). Unknown keys anywhere in `config` are rejected with error 1605. Upsert semantics: if a view already exists for `(workspace, user, template)` it is replaced in place — the row's `id` and `created` are preserved and `updated` is refreshed; otherwise a new row is inserted. Returns the stored view. Example `config`: ```json { "version": 1, "columns": [ { "field": "vendor", "visible": true, "width": 180 }, { "field": "amount", "visible": true, "width": 120 }, { "field": "notes", "visible": false } ], "sort": { "field": "amount", "dir": "desc" }, "filters": [ { "field": "vendor", "operator": "=", "value_type": "string", "value": "Acme" }, { "field": "amount", "operator": ">=", "value_type": "float", "value": 100.0 } ] } ``` **metadata-view-delete** -- Remove the caller's saved view for a template. Requires `workspace_id` and `template_id`. Only affects the caller's own saved view (other users' views for the same template are untouched). **metadata-views-list** -- List all of the caller's saved views across templates in a workspace. Requires `workspace_id`. Returns `{items, count}` where `items` is an array of saved view records (one per template the caller has a saved view for). **metadata-view-export** -- Asynchronously materialize the caller's saved view for a template into a TSV file written into workspace storage. Requires `workspace_id` and `template_id`. Optional `parent_node_id` is the destination folder OpaqueId; omit (or pass empty) to write to workspace root. The endpoint enqueues the work and returns immediately — the actual TSV is written by a background worker into the destination folder. Two response shapes: (a) **queued** — `{result:true, job_id, status:"queued", filename, message}` where `filename` is derived from the saved view's `name` (sanitized for filesystem-unsafe chars, `.tsv` extension; falls back to `metadata_view_{partialViewId}.tsv` if the sanitized name is empty); (b) **duplicate** — `{result:true, status:"duplicate", filename, message}` with NO `job_id` when an export for the same `(workspace, user, template, destination_folder)` is already queued or in flight. Same view exported to a different folder is not a duplicate. **Prerequisites**: caller must have a saved view (`metadata-view-save` first; otherwise 404 *View not found*); workspace org must have the metadata feature enabled (403 if not — billing-feature gate, Free/Pro/Business all qualify). **To detect completion**, poll the destination folder via `storage` action `list` (or via `storage` action `details` on the parent) and look for a node whose `name` matches the returned `filename`; the in-folder approach is robust against the duplicate branch (no `job_id` to track). Most exports complete within seconds. **Concurrent exports** within a single workspace are serialized by a workspace-wide Redis mutex — two callers exporting different views in the same workspace will be processed one at a time. **Snapshot semantics**: the TSV reflects the metadata state at the moment the worker runs, not at request time. **No customizing the filename or columns** — both come from the saved view; update the view first via `metadata-view-save` to change them. Per-user views: a workspace admin cannot export "the team's view"; the export reflects whatever the calling user has saved. The endpoint is rate-limited per-user and per-workspace (X-Rate-Limit-* headers). **metadata-search** -- Lexical keyword search over template + custom metadata field values for a workspace. Returns workspace files whose metadata field values contain the query keyword(s), scored by relevance. Requires `workspace_id` and `q` (search keyword(s); whitespace-trimmed; empty rejected; max 1024 chars). Optional `template_id` restricts results to nodes with at least one value contributed by that template (custom fields are excluded when this filter is set). Optional `limit` (1-100, default 100) and `offset` (default 0) for pagination — `offset+limit` may not exceed 10000. **Search semantics**: multi-token queries (e.g. `q=foo bar`) require ALL tokens (analyzer-tokenized AND); case-insensitive; **substring matching applies for queries ≤64 chars**; for longer queries only whole-word/token matching applies (a 200-char prose query is matched word-by-word, not as a substring). Returns `{results, pagination}`: each result entry is `{node_id, score (BM25 — relative sort signal only, not comparable across queries), template_ids (which templates contributed values; empty array means custom-field-only match), node (full hydrated node payload, same shape as `storage` action `details` — trashed nodes filtered out at hydration)}`. Pagination shape: `{total, limit, offset, has_more}` where `total` is the ES hit count (post-instance filter, pre-trash filter — use it for "X results" UI labels) and `has_more = (offset+limit) < total`. **Indexing latency**: metadata writes propagate to the search index asynchronously via the event queue — expect a 1-2s window after a metadata edit (template extraction, automatch, manual edit) before the new value is queryable. **Don't search-immediately-after-writing as a correctness check** — it'll race; for "show what was just saved" flows, read straight from the metadata template endpoints, not from search. **Tenancy**: the server always injects `instance_id = workspace_id` into the underlying ES filter; cross-workspace coercion is not possible. Passing another workspace's `template_id` just yields zero hits (no leak). **What it is not**: not a structured filter (use `metadata-list-files` with `metadata_filters` for `where field = value`), not semantic/vector search (lexical only — `"house"` won't match `"residence"`), not for searching file contents (use `storage` action `search` for that). For result snippets/highlights, the API does not return them; use the matched `node_id` to fetch metadata via `metadata-get` and substring-match client-side. **Saved-view auto-apply on the nodes listing endpoint.** The per-template nodes listing endpoint (`GET /workspace/{id}/metadata/templates/{tid}/nodes/`) auto-applies the caller's saved `config.sort` and `config.filters` whenever the corresponding query params (`sort_field` / `filters`) are omitted. Explicit query params always win — there is no server-side merge between stateless query params and saved-view state. `columns` is **not** auto-applied server-side; clients must render column order/visibility/width from the saved `columns` array themselves. Note the field-name quirk: the stateless `filters` query param uses `key` per entry (the legacy contract, unchanged), while saved-view `config.filters` entries use `field` — the server translates `field` → `key` internally when auto-applying a saved view. **This endpoint is not currently exposed as an MCP `workspace` action** (see the "MCP tool coverage" bullet above) — to exercise the auto-apply, call the endpoint via code-mode `execute` with `fastio.get()`. **metadata-get** -- Get all metadata for one or more files, including both template-conforming metadata and custom (freeform) key-value pairs. Single-id form: pass `node_id`; returns node details, `template_id`, `template_metadata` array, `custom_metadata` array, and a top-level `autoextractable` boolean (sibling of `template_id`, not nested inside either metadata array). `autoextractable` is `true` only when the node is a file (not a folder), not trashed, and has a completed AI summary — the same signal the extraction pipeline uses internally. Use it to gate "extract now" / "re-extract" UI affordances: if false, calling `metadata-extract` will fail or no-op (wait for the AI summary to finish first). **Bulk form (1-25 ids in one call):** pass `node_ids` as a JSON-encoded array of node IDs (all in the same workspace; cross-workspace ids surface as per-id error 191049). Duplicates dedupe before counting against the cap. The bulk response normalizes to `{format:"multi", objects, templates, errors, object_count, template_count, error_count, requested_count}` — each entry in `objects` has the same shape as the single-id body (`instance_id`, `object_id`, `template_id`, `node_id`, `template_metadata`, `custom_metadata`, `autoextractable`), and the `templates` map (keyed by `template_id`) carries each template definition exactly once instead of repeating it inside every object. Render each row by looking up `obj.template_id` in the `templates` map. The bulk call counts as **1** throttle hit regardless of fan-out, so prefer it over a per-file loop whenever a folder/picker view needs metadata for multiple files. **Per-id error codes** (in `errors[]`): `147196` invalid id format, `196136` root sentinel supplied, `191049` node not found (also returned for cross-workspace ids), `190770` transient backend error retrieving node, `150183` node exists but is not a file or note (e.g. a folder), `157684` transient backend error retrieving metadata rows. Codes `147196/196136/150183/191049` are deterministic — do **not** retry; only `190770/157684` are worth retrying. >25 ids is rejected client-side with a clear error rather than a server round-trip. **metadata-set** -- Set or update metadata key-value pairs on a file. Values must conform to the template field definitions. Requires node_id, template_id, and key_values (JSON object of key-value pairs). **metadata-delete** -- Delete metadata from a file. Provide keys (JSON array of key names) to delete specific entries, or omit to delete all metadata. Only works on files and notes, not folders. Requires node_id. **metadata-extract** -- Enqueue AI-powered metadata extraction for a file. The endpoint is **asynchronous** (HTTP 202): it enqueues a background job and returns in ~500ms with `job_id`, `status` (queued/in_progress/completed/errored), `status_uri`, `node_id`, `template_id`, and `fields` (the requested scope or null for full-row). The response does NOT contain extracted values. Requires `node_id`. Optional `template_id` (defaults to the workspace template). Optional `extract_fields` is a JSON-encoded array of field NAMES (e.g. `["vendor","amount"]`) for partial extraction; omit it for full-row extraction. **Autoextract interaction**: when `extract_fields` is omitted, the effective scope is restricted to template fields with `autoextract:true`. If every field in the template has been opted out of autoextract, the endpoint returns success with **no `job_id`** and no job is enqueued. To force extraction of a field opted out of autoextract, pass it explicitly via `extract_fields` — the explicit list is honored verbatim as a manual override. **Pre-flight gating**: check the target node's `autoextractable` flag (returned by `metadata-get`) before firing. If false, the extract will fail or no-op; wait for the AI summary to complete first. Idempotency: re-firing extract for the same `(node_id, template_id, fields)` tuple while the first call is in flight returns the same `job_id` (no duplicate job is enqueued); different `template_id` or different `extract_fields` produce distinct jobs. Extracted values are marked with `is_auto: true` and consume AI credits. **The new agent flow is**: (1) verify `autoextractable:true` via `metadata-get`; (2) call `metadata-extract`, save the returned `job_id` if present (an all-opted-out template returns success with NO `job_id` — handle that branch by passing explicit `extract_fields` as a manual override, or skip polling entirely); (3) poll `jobs-status`, filter the `metadata_extract` array for `kind:"single"` entries matching your `node_id`; (4) when an entry shows `status:"completed"`, call `metadata-get` to read values; on `status:"errored"`, surface the entry's `error_message`. Stale entries (completed or errored more than ~1 hour ago) are auto-hidden from `jobs-status`. Activity events `EVENT_METADATA_KV_EXTRACT_STARTED` / `EVENT_METADATA_KV_EXTRACT` / `EVENT_METADATA_KV_EXTRACT_ERRORED` fire on each state transition for subscribers who'd rather react than poll. **jobs-status** -- Get the workspace's async job state. Requires `workspace_id`. Returns categorized arrays of in-flight async jobs (currently includes a `metadata_extract` array; additional categories may exist for AI indexing and other background work). The `metadata_extract` array interleaves single-node entries (`kind:"single"`, with `node_id`, `job_id`, `template_id`, `fields_scope`, `status`, `progress_percent`, `started_at`, `updated_at`, `completed_at`, `error_message`) and batch entries (`kind:"batch"`, with `total_files`, `eligible_files`, `processed`, `skipped`, `failed`, `progress_percent`, etc.) — discriminate via the `kind` field. Stale completed/errored entries are auto-hidden after ~1 hour, so an absent entry should be treated as "no longer active". Poll interval: 1-3s is fine — this endpoint is generously rate-limited. **metadata-list-files** -- List files that have metadata for a specific template, with optional filtering and sorting. Requires node_id (folder to search in) and template_id. Optional metadata_filters (JSON-encoded), order_by (field key), and order_desc. **metadata-list-templates-in-use** -- List which metadata templates are in use within a folder, with usage counts per template. Requires node_id. **metadata-versions** -- Get metadata version history for a file. Returns snapshots of metadata changes over time. Requires node_id. **enable-workflow** -- Enable workflow features (tasks, worklogs, approvals, todos) on a workspace. Must be called before using workflow tools on the workspace. **disable-workflow** -- Disable workflow features on a workspace. All workflow data is preserved but inaccessible until re-enabled. **enable-import** -- Enable cloud import features (external storage providers) on a workspace. Must be called before provisioning import identities. **disable-import** -- Disable cloud import features on a workspace. Existing import sources will stop syncing, but data is preserved. **instructions-get** -- Read AI instructions for a workspace. `scope: "profile"` (default) reads the workspace-wide slot at `/workspace/{ws_id}/instructions/`. `scope: "me"` reads the per-user slot at `/workspace/{ws_id}/instructions/me/`. First read of an unwritten slot returns `content: ""` with null timestamps (not a 404). **instructions-set** -- Replace AI instructions for a workspace (full replace, max 65536 bytes UTF-8). `scope: "profile"` (default) requires owner/admin (403 code 1680 for non-admins). `scope: "me"` writes the per-user slot (any member, no guests). The two scopes are independent and do NOT merge server-side; concat client-side if you want a combined view. **instructions-clear** -- Soft-clear AI instructions for a workspace (audit row preserved). `scope: "profile"` (default) requires owner/admin; `scope: "me"` clears the per-user slot (no guests). Idempotent. ### share **list** -- List shares the authenticated user has access to. Each share includes `web_url`. **details** -- Get full details of a specific share. Returns `web_url`. **create** -- Create a new share in a workspace. **update** -- Update share settings (partial update). **delete** -- Delete (close) a share. Requires the share ID or custom name as confirmation. **public-details** -- Get public-facing share info (no membership required, just auth). **archive** -- Archive a share. Blocks guest access and restricts modifications. **unarchive** -- Restore a previously archived share to active status. **password-auth** -- Authenticate with a share password. Returns a scoped JWT for the share. **members** -- List all members of a share. Includes both active and pending members with `status` and `invite` fields (same as workspace members). **available** -- List shares available to join (joined and owned, excludes pending invitations). Each share includes `web_url`. **check-name** -- Check if a share custom name (URL name) is available. **quickshare-create** -- Create a temporary QuickShare link for a file in a workspace. Optional `expires` (seconds, default 10,800, max 604,800 = 7 days) or `expires_at` (ISO 8601 datetime). **enable-workflow** -- Enable workflow features (tasks, worklogs, approvals, todos) on a share. Must be called before using workflow tools on the share. **disable-workflow** -- Disable workflow features on a share. All workflow data is preserved but inaccessible until re-enabled. **instructions-get** -- Read AI instructions for a share. `scope: "profile"` (default) reads the share-wide slot at `/share/{share_id}/instructions/`. `scope: "me"` reads the per-user slot at `/share/{share_id}/instructions/me/`. First read of an unwritten slot returns `content: ""` with null timestamps (not a 404). **instructions-set** -- Replace AI instructions for a share (full replace, max 65536 bytes UTF-8). `scope: "profile"` (default) requires owner/admin (403 code 166463 for non-admins). `scope: "me"` writes the per-user slot — registered members only (403 code 185733 for anonymous/link guests). The two scopes are independent and do NOT merge server-side; concat client-side if you want a combined view. **instructions-clear** -- Soft-clear AI instructions for a share (audit row preserved). `scope: "profile"` (default) requires owner/admin; `scope: "me"` clears the per-user slot (registered members only, no anonymous guests). Idempotent. ### storage All storage actions require `profile_type` parameter (also accepted as `context_type`) (`workspace` or `share`) and `profile_id` (also accepted as `context_id`) (the 19-digit profile ID). **list** -- List files and folders in a directory with pagination. Each item includes `web_url` (workspace only). Requires `profile_type`, `profile_id`, and `node_id` (use `root` for root folder). **recent** -- List recently modified files and folders across all directories, sorted by updated descending. Unlike `list` which is scoped to a single folder, this returns nodes from the entire storage tree. Supports optional `type` filter (`file`, `folder`, `link`, `note`), `page_size` (100, 250, or 500), and `cursor` for pagination. For workspace folder shares, results are automatically filtered to the share's subtree. **details** -- Get full details for one or more nodes. Single lookup via `node_id` returns the legacy single shape with `web_url` (human-friendly link to the file preview or folder in the web UI, workspace only). Bulk lookup via `node_ids` (1-25 IDs, all in the same workspace/share) returns `{format: "multi", nodes, errors, node_count, error_count, requested_count}` — partial results are normal (a 200 with non-empty `errors` is not a failure; render the nodes you got and surface per-id errors next to their input IDs). Match results by `node.id` (case-insensitive); order is not preserved. Per-id error codes you may see: 133123 (not found / wrong workspace), 191878 (invalid OpaqueId), 146950 (physical content gone — stale cache after dedup, not retryable), 146256 (transient retrieval — safe to retry), 179961 (formatting failure, rare). >25 IDs is rejected client-side; chunk above that. The bulk endpoint accepts any node type (files, folders, notes, links). **search** -- Unified search: keyword + automatic semantic matching when workspace intelligence is enabled. English stemming is built in ("cats" finds "cat", "running" finds "run"). Params: `query` (required), optional `files_scope` (comma-separated nodeId:versionId pairs — scope semantic search to specific files; requires intelligence, silently ignored otherwise; max 100), `folders_scope` (comma-separated nodeId:depth pairs, depth 1-10 — scope to folder trees via BFS; requires intelligence, silently ignored otherwise; max 100), `details` ("true" to return full node details per result — previews, AI state, metadata, versions; default limit drops to 10), `limit` (1-500, default 100, or 10 with details=true), `offset`. **Always present:** `name`, `parent_id` (string|null), `type` (file, folder, or note). **Added when intelligence is on:** `relevance_score` (0.0-1.0 — keyword: 0.0-0.5, semantic: 0.5-1.0), `content_snippet` (matching text chunk, null for keyword-only — platform-capped per detail level: `terse` ~200 bytes, `standard` ~600 bytes, `full` untruncated. UTF-8 safe; a trailing `…` indicates truncation, so hits where `snippet.endsWith('…')` have more content — bump `detail` to retrieve), `match_source` ("keyword", "semantic", or "both"), `media_segment` ({start_seconds, end_seconds} for audio/video deep linking, null for non-media), `page` ({start_page, end_page} for document page-level matching, null for non-document), `mimetype` (file MIME type for semantic matches). **Added when details=true:** `node` (full node resource — previews, AI state, versions, metadata; null if node can't be loaded). **Top-level `search_metadata`** (intelligence on only): `intelligence_enabled` (bool), `semantic_available` (bool — false if gRPC failed, graceful degradation), `scoped` (bool — true when files_scope or folders_scope was used). **Intelligence off:** response contains only `name`, `parent_id`, `type` — keyword-only behavior. Each result includes `web_url` (workspace only). **Indexing latency:** freshly uploaded files take ~5-30s to appear in semantic search results while RAG ingestion completes. For immediate post-upload listing, use `list` with the parent folder instead. **trash-list** -- List items currently in the trash. Each item includes `web_url` (workspace only). **create-folder** -- Create a new folder. Returns `web_url` (workspace only). **copy** -- Copy files/folders. Single copy via `node_id` (workspace or share). Bulk copy via `node_ids` array (workspace only). Returns `web_url` on the new copy (workspace only). **move** -- Move files/folders. Single move via `node_id` (workspace or share). Bulk move via `node_ids` array (workspace only). Returns `web_url` (workspace only). **delete** -- Delete files/folders by moving them to the trash. Single delete via `node_id` (workspace or share). Bulk delete via `node_ids` array (workspace only). **rename** -- Rename a file or folder. Returns `web_url` (workspace only). **purge** -- Permanently delete a trashed node (irreversible). Requires Member permission. **restore** -- Restore files/folders from the trash. Single restore via `node_id` (workspace or share). Bulk restore via `node_ids` array (workspace only). Returns `web_url` on the restored node (workspace only). **add-file** -- Link a completed upload to a storage location. Returns `web_url` (workspace only). **add-link** -- Add a share reference link node to storage. **transfer** -- Copy or move a node to another workspace or share storage instance. Default mode is 'copy' (keeps source). Use transfer_mode='move' to copy then trash the source (cannot move root). When mode=move, response includes source_trashed (boolean) indicating whether the source was successfully trashed. **version-list** -- List version history for a file. Returns `web_url` for the file (workspace only). **version-restore** -- Restore a file to a previous version. Returns `web_url` for the file (workspace only). **lock-acquire** -- Acquire an exclusive lock on a file to prevent concurrent edits. **lock-status** -- Check the lock status of a file. **lock-release** -- Release an exclusive lock on a file. **preview-url** -- Get a preauthorized preview URL for a file. Requires `preview_type` parameter; valid values are `thumbnail`, `image`, `pdf`, `hlsstream`, `spreadsheet`. Returns `preview_url` (ready-to-use URL) and `web_url` (human-friendly link to the file in the web UI, workspace only). For raw downloads (any file type) use `download` action `file-url` instead. For image transforms (resize, crop, format conversion) use `preview-transform`. **preview-transform** -- Request a file transformation (image resize, crop, format conversion) and get a download URL for the result. Requires `transform_name` parameter. Returns `transform_url` (ready-to-use URL) and `web_url` (human-friendly link to the file in the web UI, workspace only). ### upload **create-session** -- Create a chunked upload session for a file. Accepts optional `target_node_id` to deterministically overwrite a specific existing node (`action=update` + `file_id=`): when set, `parent_node_id` is ignored and `filename` is optional (keeps existing name unless a new one is provided — enables rename-on-replace). When `filename` is omitted, the tool does one extra `storage` `details` round-trip to fetch the current name (the API still requires `name` in update mode); pass `filename` to skip it. Preserves `node_id`; new version is visible via `storage` action `version-list`. Use this instead of delete+reupload when you need to update a file's bytes. Without `target_node_id`, same-name + same-parent uploads still overwrite in place (the standard REPLACE behavior). After any overwrite, prior content is recoverable via `storage` action `version-list` / `version-restore`. **stream-upload** -- Create a stream session, upload the file body, and auto-finalize in a single call. Use for generated or piped content where the size isn't known upfront and you don't need the session ID between calls. Requires `profile_type`, `profile_id`, `parent_node_id`, `filename`, and exactly one of `content` (text) | `content_base64` (small binary, decoded server-side) | `blob_id` (POST /blob). Optional: `max_size` (see guidance above — omit to use the plan's file-size limit), `target_node_id` (overwrite a specific node; `parent_node_id` is ignored and `filename` is optional when set — omitting `filename` triggers the same extra `storage` `details` lookup noted under `create-session`), `hash`, `hash_algo`. If the stream POST fails after the session is created, the dangling session is canceled automatically. **batch** -- Upload up to 200 small files (≤4 MB each, ≤100 MB total) to one target folder in a single multipart round-trip. Requires `profile_type`, `profile_id`, and `files[]` (each entry: `filename` + exactly one of `blob_id` | `content` (text) | `content_base64` (small binary, decoded server-side); optional `relative_path`, `hash`, `hash_algo`). Optional: `folder_id` (batch-level target, defaults to instance root), `creator` (echo-back tag), `include_hash` (default `true` — computes SHA-256 client-side for entries without a hash). Returns per-entry `results[]` with `status`, `upload_id`, and `node_id`, plus a pre-filtered `errors[]` view. **`node_id` is nullable on success** — workspaces with async storage assign the node id later; do not treat null as an error. **Partial success is normal** — `count_errored > 0` with HTTP 200 is expected; retry only the errored entries. When every entry errors, the response carries `all_failed: true`. Uses a rate-limit bucket independent of the per-file upload bucket — the tool surfaces the `x-ve-limit-expires` UTC datetime on 429. Requires authentication (anon callers get HTTP 401 code 10011 — route those through the single-file `create-session` flow). **chunk** -- Upload a single chunk. Use `content` for text/strings, `content_base64` for small binary (decoded server-side), or `blob_id` for binary staged via `POST /blob`. Provide exactly one. Note: `content` is stored verbatim as UTF-8 — do NOT pass base64 there. **stream** -- Upload the entire file body into an existing stream session (one created via `create-session` with `stream=true`); auto-finalizes. Prefer `stream-upload` unless you need the `upload_id` between calls. Requires `upload_id` and exactly one of `content` (text) | `content_base64` (small binary, decoded server-side) | `blob_id`. Optional: `hash`, `hash_algo`. **finalize** -- Finalize an upload session, trigger file assembly, and poll until fully stored or failed. Returns the final session state. **status** -- Get the current status of an upload session. Supports server-side long-poll via optional `wait` parameter (in milliseconds, 0 = immediate). **cancel** -- Cancel and delete an active upload session. **list-sessions** -- List all active upload sessions for the current user. **cancel-all** -- Cancel and delete ALL active upload sessions at once. **chunk-status** -- Get chunk information for an upload session. **chunk-delete** -- Delete/reset a chunk in an upload session. **web-import** -- Import a file from an external URL into a workspace or share. **web-list** -- List the user's web upload jobs with optional filtering. **web-cancel** -- Cancel an active web upload job. **web-status** -- Get detailed status of a specific web upload job. **limits** -- Get upload size and chunk limits for the user's plan. Returns `chunk_size` (max chunk, 100 MB all plans), `size` (max file: 1 GB free/agent, 25 GB pro, 50 GB business), `chunks` (max per session: 35 free/agent, 550 pro/business), `sessions`, `sessions_size_max`. **Note:** The minimum chunk size (1 MB, except last chunk) is a fixed system constant not returned by this endpoint. Optional params: `action_context`, `instance_id`, `file_id`, `org`. **extensions** -- Get restricted and allowed file extensions for uploads. Optional `plan` param to check restrictions for a specific plan. Returns `restricted_extensions`, `archive_extensions`, `enforcement_enabled`, `plan`, `cache_ttl`. **blob-info** -- Get the `POST /blob` sidecar endpoint URL, your MCP session ID, required headers, and a ready-to-use `curl` command for shell-based file uploads. No parameters required. Use this before uploading files via the blob sidecar — it gives you everything needed to bypass MCP transport limits via `curl`. ### download **file-url** -- Get a download token and URL for a file. Optionally specify a version. Requires `profile_type`, `profile_id`, and `node_id`. **zip-url** -- Get a ZIP download URL for a folder or entire workspace/share. Returns the URL with auth instructions. Requires `profile_type`, `profile_id`, and `node_id` (use `root` for entire storage tree). **quickshare-details** -- Get metadata and download info for a quickshare link. No authentication required. ### ai All AI actions require `profile_type` parameter (also accepted as `context_type`) (`workspace` or `share`) and `profile_id` (also accepted as `context_id`) (the 19-digit profile ID). **chat-create** -- Create a new AI chat with an initial question. Default scope is the entire workspace (all indexed documents) — omit `files_scope` and `folders_scope` unless you need to narrow the search. When using scope or attachments, provide `nodeId:versionId` pairs — versionId is auto-resolved to the current version if left empty (get explicit `versionId` from `storage` action `details` — the field is omitted from `list` at the default terse detail level; pass `detail: "standard"` or higher on `list` if you want it inline). When using `files_attach`, verify `ai.attach` is `true` for each file first (check via `storage` action `details`, which defaults to `detail: "full"`). Type is auto-promoted from `chat` to `chat_with_files` when file parameters are present. Returns chat ID and initial message ID -- use message-read to get the AI response. **chat-list** -- List AI chats. **chat-details** -- Get AI chat details including full message history. **chat-update** -- Update the name of an AI chat. **chat-delete** -- Delete an AI chat. **chat-publish** -- Publish a private AI chat, making it visible to all members. **chat-cancel** -- Stops the in-progress message on a chat. Idempotent; safe to call when nothing is pending. Partial tokens are billed. **message-send** -- Send a follow-up message in an existing AI chat. Returns message ID -- use message-read to get the AI response. **message-list** -- List all messages in an AI chat. **message-details** -- Get details for a specific message in an AI chat including response text and citations. **message-read** -- Read an AI message response. Polls the message details endpoint until the AI response is complete, then returns the full text. **share-generate** -- Generate AI Share markdown with temporary download URLs for files that can be pasted into external AI chatbots. **transactions** -- List AI token usage transactions for billing tracking. **autotitle** -- Generate AI-powered title and description based on contents (share context only). ### comment All comment endpoints use the path pattern `/comments/{entity_type}/{parent_id}/` or `/comments/{entity_type}/{parent_id}/{node_id}/` where `entity_type` is `workspace` or `share`, `parent_id` is the 19-digit profile ID, and `node_id` is the file's opaque ID. **list** -- List comments on a specific file (node). Params: sort (`created`/`-created`), limit (2-200), offset, include_deleted, reference_type filter, include_total. **list-all** -- List all comments across a workspace or share (not node-specific). Same listing params as list. **add** -- Add a comment to a specific file. Body: text (max 8,192 chars total, max 500 chars display text with `@[...]` mention tags stripped). Supports mention tags: `@[profile:id]`, `@[user:opaqueId:Name]`, `@[file:fileId:name.ext]`. Optional parent_comment_id (single-level threading, replies to replies auto-flatten), optional reference (type, timestamp, page, region, text_snippet for content anchoring; exact, prefix, suffix, start_offset, end_offset for text anchoring on markdown/notes -- use type `"document"` or `"text"`), optional linked_entity_type (`task` or `approval`) and linked_entity_id to link the comment to a workflow entity at creation time. Uses JSON body. **delete** -- Delete a comment. Recursive: deleting a parent also removes all its replies. **bulk-delete** -- Bulk soft-delete multiple comments (max 100). NOT recursive: replies to deleted comments are preserved. **details** -- Get full details of a single comment by its ID. Response includes `linked_entity_type` and `linked_entity_id` (null when not linked). **reaction-add** -- Add or change your emoji reaction. One reaction per user per comment; new replaces previous. **reaction-remove** -- Remove your emoji reaction from a comment. **link** -- Link an existing comment to a workflow entity. Params: comment_id, linked_entity_type (`task` or `approval`), linked_entity_id. One link per comment; linking replaces any existing link. Returns the updated comment with linked fields populated. **unlink** -- Remove the workflow link from a comment. Params: comment_id. Returns the updated comment with linked fields set to null. **linked** -- Reverse lookup: find all comments linked to a given workflow entity. Params: linked_entity_type (`task` or `approval`), linked_entity_id. Returns a list of comments linked to the specified entity. ### event **search** -- Search the audit/event log with filters for profile, event type, category, subcategory, event name, and date range. See **Event Filtering Reference** in section 7 for the full taxonomy of categories, subcategories, and event names. **summarize** -- Search events and return an AI-powered natural language summary of the activity. Accepts the same category/subcategory/event filters as search. **details** -- Get full details for a single event by its ID. **activity-list** -- Poll for recent activity events on a workspace or share. **activity-poll** -- Long-poll for activity changes on a workspace or share. The server holds the connection until a change occurs or the wait period expires. Returns activity keys indicating what changed and a lastactivity timestamp for the next poll. ### member All member actions require `entity_type` parameter (`workspace` or `share`) and `entity_id` (the 19-digit profile ID). Member objects include `status` (`active` or `pending`) and `invite` (null for active members, `{id, created, expires}` for pending — `expires` is `YYYY-MM-DD HH:MM:SS UTC` or null if no expiration). Pending members are invited users who haven't signed up yet — they appear in member lists immediately and can be assigned tasks, approvals, and todos. When a pending member signs up, their status becomes `active` and all assignments are preserved. Canceling an invitation (via `invitation` action `delete` with `invite.id`) removes the pending member and unassigns their workflow items. **add** -- Add an existing user by user ID, or invite by email. Pass the email address or user ID as `email_or_user_id`. Inviting by email creates a pending member if the user doesn't have an account. For workspaces, set access level with `permissions` (admin/member/guest). For shares, use `role` (admin/member/guest/view). **remove** -- Remove a member (cannot remove the owner). **details** -- Get detailed membership info for a specific member. For workspaces, pass `member_id`; for shares, pass `user_id`. **update** -- Update a member's role, notifications, or expiration. **transfer-ownership** -- Transfer ownership to another member (current owner is demoted to admin). **leave** -- Leave (remove yourself). Owner must transfer ownership first. **join** -- Self-join based on organization membership. **join-invitation** -- Accept or decline an invitation using an invitation key. ### invitation All invitation actions require `entity_type` parameter (`workspace` or `share`) and `entity_id` (the 19-digit profile ID). **list** -- List all pending invitations. **list-by-state** -- List invitations filtered by state. **update** -- Resend or update an invitation (by ID or invitee email). **delete** -- Revoke and delete a pending invitation. This also removes the corresponding pending member from the member list and unassigns any workflow items (tasks, approvals, todos) assigned to them. Use the `invite.id` from the member object as the `invitation_id`. ### asset All asset actions require `entity_type` parameter (`org`, `workspace`, `share`, or `user`) and `entity_id` (the 19-digit profile ID for org/workspace/share). **upload** -- Upload an asset (e.g. logo, banner, profile photo). Provide either plain-text content or base64-encoded data (not both). **delete** -- Delete an asset. **types** -- List available asset types for the entity. **list** -- List all assets for the entity. **read** -- Read/download an asset. ### task Task list and task management for workspaces and shares. All task actions require workflow to be enabled on the target entity (`workspace` action `enable-workflow` or `share` action `enable-workflow`). **list-lists** -- List all task lists for a workspace or share. Requires `profile_type` and `profile_id`. Supports `sort_by` (created, updated, name), `sort_dir`, `limit` (1-200), `offset`, and `format` ("md" for markdown). **create-list** -- Create a new task list. Requires `profile_type`, `profile_id`, and `name` (1-255 chars). Optional `description` (max 2000 chars). **list-details** -- Get details of a specific task list. Requires `list_id`. Supports `format`. **update-list** -- Update a task list's name or description. Requires `list_id`. Optional `name`, `description`. **delete-list** -- Soft-delete a task list and all its tasks. Requires `list_id`. Destructive. **list-tasks** -- List tasks in a task list. Requires `list_id`. Supports `status` filter, `assignee` filter, `sort_by` (created, updated, name, priority, status), `sort_dir`, `limit` (1-200), `offset`, and `format`. **create-task** -- Create a new task in a list. Requires `list_id` and `title` (1-500 chars). Optional `description` (max 5000 chars), `status` (pending, in_progress, complete, blocked), `priority` (0=none, 1=low, 2=medium, 3=high, 4=critical), `assignee_id` (profile ID — can be a pending member), `dependencies` (array of task IDs), `node_id` (link to file/folder/note). **task-details** -- Get full details of a specific task. Requires `list_id` and `task_id`. Supports `format`. **update-task** -- Update a task's title, description, status, priority, assignee (including pending members), dependencies, or node link. Requires `list_id` and `task_id`. **delete-task** -- Soft-delete a task. Requires `list_id` and `task_id`. Destructive. **change-status** -- Change a task's status. Requires `list_id`, `task_id`, and `status`. **assign-task** -- Assign or unassign a task. Requires `list_id` and `task_id`. Pass `assignee_id` (profile ID, including pending members) to assign, or null/omit to unassign. **bulk-status** -- Change status on multiple tasks at once. Requires `list_id`, `task_ids` (array of task IDs, max 100), and `status`. **move-task** -- Move a task from one list to another within the same profile. Requires `list_id` (source list), `task_id`, and `target_task_list_id` (destination list). Optional `sort_order` (position in target list, default 0). Source and target lists must belong to the same profile. Returns the updated task with `old_task_list_id` and `new_task_list_id`. **reorder-tasks** -- Reorder tasks within a list. Requires `list_id` and `task_ids` (array of task IDs in the desired display order). The server converts this to `{order: [{id, sort_order}, ...]}` for the API. **reorder-lists** -- Reorder task lists within a workspace or share. Requires `profile_type`, `profile_id`, and `list_ids` (array of task list IDs in the desired display order). The server converts this to `{order: [{id, sort_order}, ...]}` for the API. **filtered-list** -- List tasks filtered by category. Requires `profile_type`, `profile_id`, and `filter` ("assigned", "created", or "status"). When filter is "status", the `status` param is also required. Supports `limit`, `offset`, and `format`. **summary** -- Lightweight task counts for a workspace or share. Requires `profile_type` and `profile_id`. Returns total tasks, breakdown by status, assigned-to-me, and created-by-me counts. Supports `format`. ### worklog Activity log for tracking agent work. After uploads, task changes, share creation, or any significant action, log what you did and why — builds a searchable audit trail for humans and AI. All worklog actions require workflow to be enabled on the target entity. **append** -- Append a new entry to the worklog. Requires `entity_type` ("task", "task_list", or "profile"), `entity_id`, and `content` (1-10000 chars). Use after making changes to record what was done and why. Entries are immutable after creation. **list** -- List worklog entries. Requires `entity_type` ("task", "task_list", or "profile") and `entity_id` (the corresponding entity's opaque ID, or profile 19-digit ID for entity_type "profile"). Supports `type` filter ("info" or "interjection"), `sort_dir` ("asc" or "desc", default "desc"), `limit` (1-200), `offset`, and `format` ("md" for markdown). **interject** -- Create an urgent interjection entry that requires acknowledgement. Requires `entity_type` ("task", "task_list", or "profile"), `entity_id`, and `content` (1-10000 chars). Interjections are priority corrections -- always treated as urgent. **details** -- Get full details of a specific worklog entry. Requires `entry_id`. Supports `format`. **acknowledge** -- Acknowledge an interjection entry, marking it as seen. Requires `entry_id`. Only entries with `acknowledgable: true` can be acknowledged. **unacknowledged** -- List unacknowledged interjections (entries where `acknowledgable` is `true`). Requires `entity_type` ("task", "task_list", or "profile") and `entity_id`. Supports `limit`, `offset`, and `format`. Always check for unacknowledged interjections before proceeding with work. **profile-list** -- List all worklog entries at the profile level. Requires `profile_type` and `profile_id`. Supports `limit`, `offset`, and `format`. Different from `list` which is entity-scoped. **filtered-list** -- List worklogs filtered by category. Requires `profile_type`, `profile_id`, and `filter` ("authored" or "interjections"). Optional `type` ("info" or "interjection") as entry-type sub-filter. Supports `limit`, `offset`, and `format`. **summary** -- Lightweight worklog counts for a workspace or share. Requires `profile_type` and `profile_id`. Returns total entries, breakdown by entry type, authored-by-me, and pending interjections counts. Supports `format`. ### approval Formal approval requests scoped to tasks, storage nodes, worklog entries, or shares. All approval actions require workflow to be enabled on the target entity. **list** -- List approval requests for a workspace or share. Requires `profile_type` and `profile_id`. Supports `status` filter (pending, approved, rejected), `limit` (1-200, default 50), `offset`, and `format`. **create** -- Create a new approval request. Requires `profile_type`, `profile_id`, `entity_type` ("task", "node", "worklog_entry", or "share"), `entity_id`, and `description` (1-65535 chars). Optional `approver_id` (profile ID of designated approver — can be a pending member), `deadline` (`YYYY-MM-DD HH:MM:SS` — NOT ISO-8601), `node_id` (artifact reference). **details** -- Get full details of an approval request including approver list and resolution. Requires `profile_type`, `profile_id`, and `approval_id` (opaque alphanumeric). Supports `format`. **resolve** -- Resolve an approval request. Requires `profile_type`, `profile_id`, `approval_id`, and `resolve_action` ("approve" or "reject"). Optional `comment` (max 5000 chars). Only designated approvers can resolve. **bulk-create** -- Bulk-create node approvals for every file and note in a share (max 50 nodes). Requires `profile_id` and `description` (1-65535 chars). Optional `approver_id` (can be a pending member), `deadline` (`YYYY-MM-DD HH:MM:SS` — NOT ISO-8601). Share-only, members/admins only. **bulk-approve** -- Bulk-approve all pending approvals in a share. Requires `profile_id`. Optional `comment` (max 5000 chars). Skips stale approvals (version_match=false). Guests can approve their assigned approvals. **bulk-reject** -- Bulk-reject all pending approvals in a share. Requires `profile_id`. Optional `comment` (max 5000 chars). Skips stale approvals (version_match=false). Guests can reject their assigned approvals. **filtered-list** -- List approvals filtered by category. Requires `filter` ("pending", "created", "assigned", or "resolved"). Optional `profile_type` and `profile_id` for workspace/share scope; omit both for cross-profile user-level view (`/user/approvals/list/{filter}`). Note: the `assigned` filter is only available with `profile_type`/`profile_id`; it is not supported for cross-profile user-level queries. Supports `status` sub-filter, `limit`, `offset`, and `format`. **summary** -- Lightweight approval counts for a workspace or share. Requires `profile_type` and `profile_id`. Returns created-by-me and assigned-to-me breakdowns with pending/approved/rejected counts. Supports `format`. **update** -- Update a pending approval. Requires `profile_type`, `profile_id`, and `approval_id`. At least one of: `description` (1-65535 chars), `approver_id` (can be a pending member), `deadline` (`YYYY-MM-DD HH:MM:SS` — NOT ISO-8601), `node_id`, `properties` (JSON object). Only pending approvals can be updated. Status, entity_type, entity_id, and profile_id are immutable. **delete** -- Permanently delete an approval (any status). Requires `profile_type`, `profile_id`, and `approval_id`. Irreversible. Members and admins only; guests blocked. **bulk-delete** -- Permanently delete all approvals in a share (up to 500). Requires `profile_id`. Deletes both pending and resolved approvals. Members and admins only; guests blocked. ### todo Simple flat checklists scoped to workspaces and shares. No nesting. All todo actions require workflow to be enabled on the target entity. **list** -- List todos for a workspace or share. Requires `profile_type` and `profile_id`. Supports `filter_done` (boolean), `sort_by` (created, updated, title), `sort_dir`, `limit` (1-200, default 100), `offset`, and `format`. **create** -- Create a new todo item. Requires `profile_type`, `profile_id`, and `title` (1-500 chars). Optional `assignee_id` (can be a pending member). **details** -- Get full details of a todo. Requires `todo_id` (opaque alphanumeric). Supports `format`. **update** -- Update a todo. Requires `todo_id`. Supports `title`, `assignee_id` (can be a pending member), `done`. **delete** -- Soft-delete a todo. Requires `todo_id`. Destructive. **toggle** -- Toggle the done state of a todo. Requires `todo_id`. Flips between done and not done. **bulk-toggle** -- Set done state on multiple todos at once. Requires `profile_type`, `profile_id`, `todo_ids` (array of todo IDs, max 100), and `done` (boolean: true to mark done, false to mark not done). **filtered-list** -- List todos filtered by category. Requires `profile_type`, `profile_id`, and `filter` ("assigned", "created", "done", or "pending"). Supports `limit`, `offset`, and `format`. **summary** -- Lightweight todo counts for a workspace or share. Requires `profile_type` and `profile_id`. Returns total, done, pending, assigned-to-me, and created-by-me counts. Supports `format`. ### apps Interactive MCP App widget discovery and launching. Widgets are interactive HTML5 UIs that render in agent conversations. **list** -- List all available MCP App widgets with their metadata (title, description, supported tools, supported actions, resource URI). **details** -- Get full metadata for a specific widget. Requires `app_id` (the widget name, e.g., "file-picker"). **launch** -- Launch a widget with workspace or share context. Requires `app_id`, `profile_type` ("workspace" or "share") (also accepted as `context_type`), and `profile_id` (the 19-digit profile ID) (also accepted as `context_id`). Returns the widget HTML content ready for rendering. **get-tool-apps** -- Find widgets associated with a specific tool domain. Requires `tool_name` (e.g., "storage", "ai", "comment"). Returns widgets that provide UI for that tool's operations. --- ## 10. Code Mode (Headless Agents) When connecting from a headless agent (Claude Code, Cursor, Continue, etc.), the server automatically enables Code Mode -- a lightweight alternative to the full 19-tool set. Code Mode exposes 4 tools total: | Tool | Purpose | |------|---------| | `auth` | Authentication (signin, signup, API keys, PKCE, 2FA) | | `upload` | File uploads (chunked, text, web-import) | | `search` | Find content (files, notes, folders) OR discover API endpoints | | `execute` | Make authenticated API calls to Fast.io | Clients with MCP Apps support (Claude Desktop, Cline) continue to receive the full 19-tool set plus 6 app-* widget tools (one per widget in the registry). Unknown clients default to the full tool set. ### Finding Content (USE THIS FIRST) When the user asks "find my X", "where is my Y", or "do I have a Z" in their Fast.io data, call `search` **without** setting `target` (defaults to `content`). Do NOT compose `/storage/search/` calls by hand through `execute` — the `search` tool already wraps the right endpoints, fans out across workspaces, and normalizes results. ``` search query="tax return 2023" (fan out across ALL workspaces) search query="Q3 budget" workspace_id="1234567890123456789" (scoped to one workspace) search query="invoice" share_id="9876543210987654321" (scoped to one share) search query="meeting notes from last quarter" details=true (semantic, with full node details) ``` Result shape: ```json { "results": [ { "id": "<30-char node id>", "type": "file", "name": "tax-return-2023.pdf", "parent_id": "", "workspace_id": "1234…", "score": 0.87, "snippet": "…2023 tax return for…" } ], "total": 1, "scope": { "type": "workspace", "workspace_ids": ["1234…"] }, "next_offset": 50 } ``` **Keyword vs. semantic search:** With workspace intelligence OFF (the default), search matches file and folder **names** only — fast and free. With intelligence ON, the same endpoint also runs semantic (RAG) search over indexed document content and returns `score` and `snippet` fields. Enable intelligence with `execute POST /workspace/{id}/update/ intelligence=true`. Indexing costs ~10 credits per document page; queries themselves are free. **Narrowing semantic search:** Pass `folders_scope` (`nodeId:depth` pairs, depth 1-10) to limit results to a subtree, or `files_scope` (`nodeId:versionId` pairs) to limit to specific file versions. Both are silently ignored when intelligence is off. **Scopes:** - `workspace_id` given → single-workspace search with `limit`/`offset` pagination. - `share_id` given → single-share search. - Neither → fan out across the top 10 accessible workspaces (4-way concurrent). Pagination is not available across the fanout; for deep pagination, pass an explicit `workspace_id`. ### search Tool (API-endpoint discovery) When you need to call a REST endpoint that is NOT already wrapped by the code-mode tools (`auth`, `upload`, `search` content mode), flip `target` to `"api"` to search the API spec. Returns matching endpoints with method, path, parameters, and descriptions — pass the chosen path to `execute`. ``` search target="api" query="list files in workspace" tag="storage" search target="api" query="create share" tag="share" search target="api" query="authentication" search target="api" query="pagination" include_concepts=true ``` Parameters (all modes): - `query` (string, required) -- Keywords, endpoint paths, or concepts (api mode) or the thing you're trying to find (content mode) - `target` (enum, optional) -- `"content"` (default) or `"api"` Parameters (content mode only): - `workspace_id` (string, optional) -- 19-digit workspace ID to scope to one workspace - `share_id` (string, optional) -- 19-digit share ID to scope to one share - `limit` (number, optional) -- Max results 1-200 (default 50 single-scope, 25 per-workspace on fanout) - `offset` (number, optional) -- Pagination offset for single-scope search - `details` (boolean, optional) -- Include full node details (previews, AI state, metadata). Default false - `folders_scope` (string, optional) -- Narrow semantic search to folder subtrees (requires intelligence) - `files_scope` (string, optional) -- Narrow semantic search to specific file versions (requires intelligence) Parameters (api mode only): - `tag` (string, optional) -- Filter by domain: auth, workspace, storage, ai, share, upload, org, user, member, comment, event, metadata, etc. - `include_concepts` (boolean, optional) -- Include concept docs (pagination, IDs, errors). Default true. ### execute Tool Make authenticated API calls to the Fast.io REST API. Use `search` first to discover endpoints. Methods: - `get` -- GET request with optional query parameters - `post` -- POST with form-encoded body (default API format) - `postJson` -- POST with JSON body - `delete` -- DELETE request - `put` -- PUT with form-encoded body The auth token is injected automatically. Path parameters must be filled by the caller (replace `{workspace_id}` with the actual ID). For multi-step operations, make multiple sequential execute calls. ``` execute method="get" path="/org/1234567890123456789/list/workspaces/" ``` ``` execute method="post" path="/workspace/1234567890123456789/storage/root/createfolder/" body={"name": "reports"} ``` ``` execute method="postJson" path="/workspace/1234567890123456789/storage/root/createnote/" body={"name": "summary.md", "content": "# Summary"} ``` Parameters: - `method` (enum, required) -- HTTP method: "get", "post", "postJson", "delete", "put" - `path` (string, required) -- API endpoint path (e.g., '/orgs/list/', '/workspace/{workspace_id}') - `body` (object, optional) -- Request body (form-encoded for post/put, JSON for postJson) - `params` (object, optional) -- Query parameters appended to the URL - `timeout_ms` (number, optional) -- Timeout in ms (default 30000, max 60000) #### Response Handling The execute tool handles three response types automatically: - **JSON** (most endpoints) -- parsed as standard Fast.io API envelope - **Text** (markdown, plain text, etc.) -- returned as `{ content, content_type, http_status }` - **Binary** (images, PDFs, etc.) -- returns metadata with guidance to use `download://` MCP resource #### Reading Notes in Code Mode Use `/readnote/` (returns JSON) instead of `/read/` (returns raw binary): ``` execute method="get" path="/workspace/{workspace_id}/storage/{node_id}/readnote/" ``` For reading uploaded files (non-notes), use the `download://` MCP resource: ``` resources/read uri="download://workspace/{workspace_id}/{node_id}" ```