> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fluid.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract.
> Authenticate with the header Authorization: Bearer <token>; public storefront read endpoints require no auth.
> To sign a new merchant up for Fluid programmatically, run `fluid signup` from the Fluid CLI, or call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token.
> After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors.
> Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile.
> The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country).
> api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.
> Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other.
> For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces.
> Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings.
> Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties.
> Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables.
> A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation.
> The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations.
> Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check.
> Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times.

# Upload a private file

> Store a profile picture, contact photo, or other personal file and get its URL back, without adding it to your company's DAM.

Some files belong to a person, not to your company's library: a member's profile picture, a photo on a contact, an image attached to a support message. Uploading them to the DAM would put them in **Files**, where every admin can browse and reuse them.

Private uploads store the file and return its URL, and that's all. No DAM asset or media item is created, so the file never appears in **Files**, the DAM picker, or the media list. You save the URL (or, for members, the upload id) wherever the file belongs.

There are two routes on `upload.fluid.app`, one for each kind of token:

| Route | Use it for | Token |
| - | - | - |
| `POST https://upload.fluid.app/api/company/v2026-10/private-uploads` | Files your integration stores for the company, such as contact photos | A company token or a partner token whose role can update media |
| `POST https://upload.fluid.app/api/member/v2026-10/private-uploads` | Files a member uploads for themselves, such as their own profile picture | The member's own Bearer token |

> [!NOTE]
>
> Neither route takes a company, member, or folder in the request. The owner always comes from the token, so a file can only land in the token's own company or member storage.

## Before you start

* **Use this host, not `api.fluid.app`.** The upload service runs on `upload.fluid.app`.
* **Keep company and partner tokens on your server.** Never send either to a browser. A member route call can come from the member's own app or browser session, since it carries only that member's token.
* **"Private" means out of the DAM, not access-controlled.** Each file gets a random, unguessable name, but anyone who has the URL can open it. Don't use private uploads for documents that need signed or expiring links.

## Send the file

Both routes take the same body. Send the file as `multipart/form-data`:

| Field | Required | Description |
| - | - | - |
| `file` | Yes | The file to upload. |
| `fileName` | No | The file name, including its extension. Defaults to the file part's own filename. Fluid uses the extension to work out the file type when the part has none. |

Or, if you already have the bytes in memory, send `application/json` with the file base64-encoded:

| Field | Required | Description |
| - | - | - |
| `data_uri` | One of these | A data URI, for example `data:image/png;base64,iVBORw0KGgo...`. |
| `b64_json` | One of these | Raw base64. Send `mime_type` with it. |
| `mime_type` | No | The file type for `b64_json`. Defaults to `image/png`. |
| `fileName` | No | The file name, including its extension. Generated from the file type if you leave it out. |

The stored name is always a random prefix plus a cleaned-up version of `fileName`, so two uploads of `headshot.jpg` never collide.

## Set a member's profile picture

A member uploads their photo with their own token:

```bash theme={null}
curl -X POST "https://upload.fluid.app/api/member/v2026-10/private-uploads" \
  -H "Authorization: Bearer <member_token>" \
  -F "file=@headshot.jpg"
```

The response carries the stored file and an `upload_id`:

```json theme={null}
{
  "data": {
    "url": "https://ik.imagekit.io/fluid/companies/0199a1b2-6c4e-7d21-9f30-8b7e1a2c3d4f/members/48213/uploads/images/Xk3p9QaB_headshot.jpg",
    "file_id": "6718f0c2a9b3e41d7c5e2f90",
    "file_path": "/companies/0199a1b2-6c4e-7d21-9f30-8b7e1a2c3d4f/members/48213/uploads/images/Xk3p9QaB_headshot.jpg",
    "name": "Xk3p9QaB_headshot.jpg",
    "size": 52114,
    "mime_type": "image/jpeg",
    "width": 800,
    "height": 800,
    "upload_id": "0199a3f2-5b0d-7c3a-8f09-2a1b0c9d8e7f",
    "expires_at": "2026-10-24T18:39:05Z"
  }
}
```

Uploading only stores the file. To make it the member's picture, send `upload_id` as `avatar_upload_id` to [update the signed-in member](https://docs.fluid.app/api-reference/me/update-the-signed-in-member.md):

```bash theme={null}
curl -X PATCH "https://api.fluid.app/api/member/v2026-10/me" \
  -H "Authorization: Bearer <member_token>" \
  -H "Content-Type: application/json" \
  -d '{ "avatar_upload_id": "0199a3f2-5b0d-7c3a-8f09-2a1b0c9d8e7f" }'
```

Fluid checks that the stored file is really there and is an image before it sets the picture. Each `upload_id` works once, and must be used within an hour of `expires_at`.

The member route accepts images, videos, PDFs, and presentations. Images can be up to 10 MB, videos 100 MB, and documents 25 MB.

## Add a photo to a contact

Your server uploads the photo with a company token:

```bash theme={null}
curl -X POST "https://upload.fluid.app/api/company/v2026-10/private-uploads" \
  -H "Authorization: Bearer <company_token>" \
  -F "file=@dana-whitfield.jpg"
```

```json theme={null}
{
  "data": {
    "url": "https://ik.imagekit.io/fluid/1234/private/images/Rt7mW2qL_dana-whitfield.jpg",
    "file_id": "6718f1d4b2c6a93e8f0d1a27",
    "file_path": "/1234/private/images/Rt7mW2qL_dana-whitfield.jpg",
    "name": "Rt7mW2qL_dana-whitfield.jpg",
    "size": 38720,
    "mime_type": "image/jpeg",
    "width": 600,
    "height": 600
  }
}
```

Save `url` on the record it belongs to. Nothing else refers to the file, so if you don't store the URL, the file is orphaned.

The company route refuses SVG, HTML, XML, JavaScript, and executable files. Images can be up to 10 MB, videos 100 MB, audio 50 MB, and documents and other files 25 MB.

## Errors

Errors return `{ "error": "..." }`. When Fluid or the storage service refused the request, the body also carries their response under `details`.

| Status | Meaning |
| - | - |
| `400` | The request is malformed: the wrong content type, invalid JSON, or no file. |
| `401` | The `Authorization` header is missing, or the token isn't valid. A company token on the member route is a `401`. |
| `403` | The token is valid but can't upload: a company token whose role can't update media, or a read-only member token. |
| `413` | The request is larger than 100 MB. |
| `422` | The file type isn't allowed, or the file is over its size limit. |
| `502` | Fluid or the storage service failed. Nothing was saved to a record, so it's safe to retry. |

Any other `4xx` from Fluid is passed back with its own status.

## Related

* [Upload a file to the DAM](https://docs.fluid.app/api/dam-upload.md) — for files that belong in the company library.
* [Member APIs](https://docs.fluid.app/api/member-apis.md) — member tokens and the signed-in member.
* [Authentication](https://docs.fluid.app/api/authentication.md) — company and partner tokens.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.