> ## 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.
> To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. A Site can serve light server code: each functions/<name>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/<name> on the Site's own host; publish it with fluid deploy (the MCP site_deploy tool does not carry functions). See /sites/functions and /sites/rest-api.
> 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.

# Ask Mist to check finished work

> Asks Mist to check a task in review, as the person's question in the chat the task came from: the oldest linked chat the caller can open, else the caller's chat started from the task, else a new chat started from it. The check run only reads and ends with a saved review. Requires multiplayer_tasks.view (or application_themes.view), multiplayer_discussions.view, multiplayer_discussions.create, multiplayer_discussions.reply and mist.view. The question, a new chat and the run are saved together, or none of them. A retry with the same client id returns the same chat, question and run while that check runs or once it saved its review, and only while the caller can still open the chat; after a check that failed, was cancelled, or finished without a review it starts the next attempt. A check whose outcome is unknown is returned, not asked again, since it may have reached the model. A client id names one task version's check, so another task or version is a conflict.



## OpenAPI

````yaml /api-reference/multiplayer-v2026-04.yaml post /api/v202604/multiplayer/tasks/{task_id}/reviews
openapi: 3.1.0
info:
  title: Fluid Cowork API v2026-04
  version: v2026-04
  description: |
    Cowork is the company's shared board of work: tickets that people file,
    plan, assign and finish, that Mist can work on, and that a company can send
    to an agency to do for it. The Mist task board and Cowork in the Fluid admin
    are built on this API, so everything they do is available through it.

    **Authentication.** Every endpoint needs a Bearer token for a person: a
    company admin's session, or the token of their company membership. A
    company API token is refused with `403`, because each write is recorded
    against the person who made it. The permissions each endpoint needs, such
    as `multiplayer_tasks.create` or `multiplayer_discussions.view`, are listed
    on the endpoint.

    **Feature flags.** Discussions, preview threads and everything to do with
    agencies also need the company's `COWORK` flag. A company without it gets
    `404` from those endpoints.

    **Versions.** A task carries a `lock_version`. A write whose body takes
    `expected_version`, such as changing a task's content, priority, due
    date, status or assignee, compares it with the task's `lock_version`, and
    answers `409` with the current task when the task has changed since, so
    retry against that one. Each endpoint's body says whether it takes one.
    Moving a card on the board does not: `PUT /tasks/{id}/position` is
    ordered by the client's `board_position_at_ms` stamp, an older placement
    is discarded and answered with the current task, and placing work never
    changes its `lock_version`.

    **Agencies.** A company sends a task to an agency with an agency request.
    The agency's members then work it through the Agency work and Agency time
    endpoints, which need a person who belongs to that agency.
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.fluid.app
security: []
tags:
  - name: Cowork tasks
    description: >-
      The company's work, one task per ticket. Create, read, change and delete
      tasks, and read the board that draws them.
    x-fluid-section: Cowork
  - name: Task channels and attachments
    description: >-
      A task's comment channel, its images and files, and the discussions it is
      linked to.
    x-fluid-section: Cowork
  - name: Task assessments
    description: >-
      Mist's check of a task before work starts, the answers to its questions,
      and what to do when it finds a duplicate.
    x-fluid-section: Cowork
  - name: Mist runs
    description: >-
      Starting Mist on a task, Mist claiming and finishing the work, and asking
      Mist to review finished work.
    x-fluid-section: Cowork
  - name: Agency requests
    description: >-
      Sending a task to an agency, and the company's answers to the agency's
      quotes and finished work.
    x-fluid-section: Cowork
  - name: Discussions
    description: The company's chats with Mist, their messages, and the work they lead to.
    x-fluid-section: Cowork
  - name: Preview threads
    description: The theme preview comments that stand in for work on the board.
    x-fluid-section: Cowork
  - name: Agency work
    description: >-
      For an agency's members, the tickets customers sent the agency, and
      picking them up, quoting, declining and finishing them.
    x-fluid-section: Cowork
  - name: Agency time
    description: >-
      For an agency's members, the time they log on tickets and the timer that
      records it.
    x-fluid-section: Cowork
paths:
  /api/v202604/multiplayer/tasks/{task_id}/reviews:
    post:
      tags:
        - Mist runs
      summary: Ask Mist to check finished work
      description: >-
        Asks Mist to check a task in review, as the person's question in the
        chat the task came from: the oldest linked chat the caller can open,
        else the caller's chat started from the task, else a new chat started
        from it. The check run only reads and ends with a saved review. Requires
        multiplayer_tasks.view (or application_themes.view),
        multiplayer_discussions.view, multiplayer_discussions.create,
        multiplayer_discussions.reply and mist.view. The question, a new chat
        and the run are saved together, or none of them. A retry with the same
        client id returns the same chat, question and run while that check runs
        or once it saved its review, and only while the caller can still open
        the chat; after a check that failed, was cancelled, or finished without
        a review it starts the next attempt. A check whose outcome is unknown is
        returned, not asked again, since it may have reached the model. A client
        id names one task version's check, so another task or version is a
        conflict.
      operationId: checkMultiplayerTask
      parameters:
        - name: task_id
          in: path
          required: true
          description: The task UUID.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            example:
              check:
                client_id: recheck-newer
                expected_version: 1
                review_id: 01a1d0e3-c68a-7809-bc99-3fe404ee54dc
            schema:
              type: object
              required:
                - check
              properties:
                check:
                  type: object
                  required:
                    - client_id
                    - expected_version
                  properties:
                    client_id:
                      type: string
                      maxLength: 200
                      pattern: ^(?![A-Za-z0-9_-]*-r[0-9]+$)[A-Za-z0-9_-]+$
                      description: >-
                        The client's identity for this check; a retry with it
                        returns the same chat, question and run. It may not end
                        in -r and a number, which the server adds to the
                        attempts after a check that ended without a review.
                    expected_version:
                      type: integer
                      minimum: 0
                      description: >-
                        The task version the person saw in review. A mismatch is
                        a conflict.
                    review_id:
                      type: string
                      format: uuid
                      description: >-
                        The review a Check again comes from. The check is
                        refused as a conflict once a newer review of the task,
                        visible to the caller, replaced it.
      responses:
        '202':
          description: The chat, the person's question and the accepted check run.
          content:
            application/json:
              example:
                discussion:
                  id: 01a1d0e4-13c8-7ae9-b786-6ccb6db2bbe6
                  answer_claim: null
                  channel: null
                  client_id: check-new-chat
                  company_id: 96778814
                  created_at: '2026-11-12T17:52:50Z'
                  creator:
                    id: '433400890'
                    name: Admin Acme
                    kind: user
                  message_count: 1
                  shared_at: null
                  source:
                    kind: task
                    id: 9271f7b9-237c-5dbe-ab78-f866652d747a
                  title: Add customer videos
                  updated_at: '2026-11-12T17:52:50Z'
                message:
                  id: 01a1d0e4-13c9-747f-8caa-abc3f780f599
                  admin_page: null
                  author:
                    id: '433400890'
                    name: Admin Acme
                    kind: user
                  body: Check the finished work on “Add customer videos”.
                  client_id: check-new-question
                  created_at: '2026-11-12T17:52:50Z'
                  discussion_id: 01a1d0e4-13c8-7ae9-b786-6ccb6db2bbe6
                  page_results: []
                  resource_results: []
                  role: human
                  round_limit_reached: false
                  sequence: 1
                run_id: 01a1d0e4-13ce-7f3d-b6ee-d542ee438766
                status: 202
                meta:
                  request_uuid: null
                  timestamp: '2026-11-12T17:52:50Z'
              schema:
                type: object
                required:
                  - discussion
                  - message
                  - run_id
                  - status
                  - meta
                properties:
                  discussion:
                    $ref: '#/components/schemas/Discussion'
                  message:
                    $ref: '#/components/schemas/DiscussionMessage'
                  run_id:
                    type: string
                    format: uuid
                    description: The check run
                    read through the AI runs API.: null
                  status:
                    const: 202
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          description: Authentication is required.
        '403':
          description: >-
            A user session, company admin status, and the read, chat and Mist
            grants are required, or a retried check's chat is no longer open to
            the caller.
        '404':
          description: >-
            The task or the named review is unavailable in this company, or
            Cowork is not enabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The task is no longer in review at that version, the client id
            started a check of another task, or a newer review replaced the
            named one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            The check could not be started now, for example while billing cannot
            admit the run; nothing was saved. Retry with the same client id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer_auth: []
components:
  schemas:
    Discussion:
      type: object
      description: >-
        A company chat. It is private to its creator until they share it with
        the work it led to. It holds no task state.
      required:
        - id
        - client_id
        - company_id
        - title
        - source
        - creator
        - message_count
        - channel
        - shared_at
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        client_id:
          type: string
        company_id:
          type: integer
        title:
          type: string
        source:
          oneOf:
            - $ref: '#/components/schemas/DiscussionSource'
            - type: 'null'
        creator:
          $ref: '#/components/schemas/Person'
        message_count:
          type: integer
          minimum: 1
          description: How many messages the discussion has accepted.
        answer_claim:
          description: >-
            Which runtime is answering a person's newest question, while that
            stops another from answering it; null otherwise.
          anyOf:
            - $ref: '#/components/schemas/DiscussionAnswerClaim'
            - type: 'null'
        channel:
          description: >-
            The texting channel this chat collects messages from, or null for a
            chat held in Fluid. Messages arrive from outside the browser, so
            clients read such a chat again while it is open.
          anyOf:
            - $ref: '#/components/schemas/DiscussionChannel'
            - type: 'null'
        shared_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the creator shared the chat with its work. Null while it is
            private, readable only by its creator.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    DiscussionMessage:
      type: object
      description: >-
        One message, numbered in the order the discussion accepted it. A
        person's message is immutable.
      required:
        - id
        - discussion_id
        - sequence
        - role
        - client_id
        - author
        - body
        - created_at
      properties:
        id:
          type: string
          format: uuid
        discussion_id:
          type: string
          format: uuid
        sequence:
          type: integer
          minimum: 1
        role:
          type: string
          enum:
            - human
            - assistant
        client_id:
          type:
            - string
            - 'null'
          description: >-
            The client-generated identity of a person's message; null for an
            assistant message.
        author:
          description: The person who wrote the message, or null for an assistant message.
          anyOf:
            - $ref: '#/components/schemas/Person'
            - type: 'null'
        body:
          type: string
        admin_page:
          description: >-
            The admin page open beside the chat when a person sent this message;
            null when it was sent from none, and for every assistant message.
          anyOf:
            - $ref: '#/components/schemas/DiscussionAdminPage'
            - type: 'null'
        format:
          type: string
          enum:
            - text
          description: >-
            Present for server-produced conversational text and first-party
            client answers. Preserve its body without interpreting legacy answer
            headings; absent for older messages.
        producer:
          type: string
          enum:
            - mist_desktop
          description: >-
            Present only on an answer a first-party client published, naming the
            client that wrote it.
        result_id:
          type: string
          description: >-
            Present only on an answer a first-party client published; the
            client's own identity for that answer, so it can recognise the
            answer in a later read.
        resource_results:
          type: array
          maxItems: 20
          description: >-
            Product and order cards saved with a Mist answer, in displayed
            order, for the current reader; empty for other messages.
          items:
            $ref: '#/components/schemas/MistResourceResult'
        page_results:
          type: array
          maxItems: 10
          description: >-
            Storefront pages read or captured for a Mist answer, in the order
            they were read, for the current reader; empty for other messages.
          items:
            $ref: '#/components/schemas/MistPageResult'
        withdraws:
          type: object
          description: >-
            Present only on a person's message that took earlier messages back,
            in the shape the append request sends it. Those messages stay in the
            discussion; readers that rebuild the conversation skip them. Absent
            on every other message.
          required:
            - from_sequence
            - through_sequence
          properties:
            from_sequence:
              type: integer
              minimum: 1
              description: The sequence of the first message taken back.
            through_sequence:
              type: integer
              minimum: 1
              description: The sequence of the last message taken back, ends included.
        round_limit_reached:
          type: boolean
          description: >-
            True when a Mist answer was written by a round that could not call
            tools, because its run used its last model round or had no room for
            more tool results, so it may have left part of the question
            unanswered. A person can ask Mist to continue. False for every other
            message.
        created_at:
          type: string
          format: date-time
    Meta:
      type: object
      required:
        - request_uuid
        - timestamp
      properties:
        request_uuid:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
        - status
        - meta
      properties:
        error:
          type: object
          required:
            - message
            - details
          properties:
            message:
              type: string
            details:
              type: object
        status:
          type: integer
        meta:
          $ref: '#/components/schemas/Meta'
    DiscussionSource:
      type: object
      description: >-
        The original company record selected when this assistant conversation
        started.
      required:
        - kind
        - id
      properties:
        kind:
          type: string
          enum:
            - task
            - preview_thread
        id:
          type: string
          minLength: 1
          maxLength: 64
    Person:
      type: object
      description: >-
        One person on a card. Mist is a person here, with a fixed id and no user
        row.
      required:
        - id
        - name
        - kind
      properties:
        id:
          type: string
          description: The user id as a string, or `mist` for the agent.
        name:
          type:
            - string
            - 'null'
          description: The name the server attributed, falling back to the email address.
        kind:
          type: string
          enum:
            - user
            - agent
          description: Whether this is a person or the agent.
    DiscussionAnswerClaim:
      type: object
      description: >-
        Which runtime is answering a question in the chat. While a claim is
        live, or once its holder has answered, no other runtime answers that
        question. The chat holds one claim: a claim on a later question replaces
        an answered one, and an answered question is not answered again.
      required:
        - producer
        - through_sequence
        - answered
        - expires_at
      properties:
        producer:
          type: string
          description: >-
            What the holder publishes as, such as mist_desktop or
            cowork_conversation.
        through_sequence:
          type: integer
          minimum: 1
          description: The sequence of the claimed question.
        answered:
          type: boolean
          description: >-
            True once the holder published its answer; the claim then holds
            until a newer message from the person who asked the question, or a
            claim on a later question.
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When an unanswered claim ends unless renewed; null for an answer
            published without one.
    DiscussionChannel:
      type: object
      additionalProperties: false
      required:
        - kind
        - number_last4
      properties:
        kind:
          type: string
          enum:
            - sms
        number_last4:
          type:
            - string
            - 'null'
          pattern: ^[0-9]{4}$
          description: >-
            The last four digits of the linked phone number, for the person who
            linked it. Null for anyone else reading a shared chat.
    DiscussionAdminPage:
      type: object
      description: >-
        The admin page open beside the chat when a person sent a message. It
        records where they were, as their client reported it; it is not evidence
        that the record exists or that a reader may see it. A request's other
        keys in this object are ignored, as in every nested object of these
        requests.
      required:
        - type
      properties:
        type:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^[a-z0-9_-]+(/[a-z0-9_-]+)*$
          description: >-
            The page's admin section, such as products, orders or
            settings/payments.
        id:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^[A-Za-z0-9_-]+$
          description: >-
            The record the page shows, when it shows one; absent on a section
            page such as a list.
    MistResourceResult:
      type: object
      description: >-
        A product or order card projected from a saved api_get answer for the
        current reader. Facts stay as observed; the reader's grant for the
        source kind and the record's presence in the company are checked when
        the card is read. Model prose never creates a card.
      additionalProperties: false
      required:
        - receipt_id
        - request_id
        - tool_call_id
        - recorded_at
        - source_kind
        - source_id
        - state
        - observation
        - admin_path
        - api_path
        - required_permissions
        - summary
      properties:
        receipt_id:
          type: string
          maxLength: 256
          description: Stable identity of the card within its saved read.
        request_id:
          type: string
          format: uuid
          description: The model attempt whose tool call made the read.
        tool_call_id:
          type: string
          maxLength: 128
          description: The tool call that made the read.
        recorded_at:
          type: string
          format: date-time
          description: When the read was saved.
        source_kind:
          type: string
          enum:
            - product
            - order
          description: The kind of record.
        source_id:
          type:
            - string
            - 'null'
          pattern: ^[1-9][0-9]{0,18}$
          description: The record id; null when the card is unavailable.
        state:
          type: string
          enum:
            - available
            - unavailable
          description: Unavailable when the record no longer exists in this company.
        observation:
          type: string
          enum:
            - list
            - detail
          description: Whether the card came from a list read or a detail read.
        admin_path:
          type:
            - string
            - 'null'
          pattern: ^/(products|orders)/[1-9][0-9]{0,18}$
          description: The record's admin page; null when unavailable.
        api_path:
          type:
            - string
            - 'null'
          maxLength: 512
          description: The API path that was read
          without its query; null when unavailable.: null
        required_permissions:
          type: array
          minItems: 1
          maxItems: 1
          description: The reader grant this card requires.
          items:
            type: string
            enum:
              - storefront.view
              - orders.view
        summary:
          description: Bounded facts from the saved answer; null when unavailable.
          anyOf:
            - $ref: '#/components/schemas/MistProductSummary'
            - $ref: '#/components/schemas/MistOrderSummary'
            - type: 'null'
    MistPageResult:
      type: object
      description: >-
        A storefront page Cowork read or captured, projected from its saved
        read_page or capture_page receipt for a reader already allowed to see
        the run or conversation. Restored without fetching the page again.
        Unavailable, with no URL, title or picture, when the page's host is no
        longer this company's storefront.
      additionalProperties: false
      required:
        - receipt_id
        - request_id
        - tool_call_id
        - recorded_at
        - kind
        - state
        - url
        - final_url
        - observed_at
        - title
        - viewport
        - screenshot_url
      properties:
        receipt_id:
          type: string
          maxLength: 256
          description: Stable identity of the result within its saved read.
        request_id:
          type: string
          format: uuid
          description: The model attempt whose tool call read the page.
        tool_call_id:
          type: string
          maxLength: 128
          description: The tool call that read the page.
        recorded_at:
          type: string
          format: date-time
          description: When the read was saved.
        kind:
          type: string
          enum:
            - text
            - screenshot
          description: A text read of the page as served
          or a captured screenshot of its visible part.: null
        state:
          type: string
          enum:
            - available
            - unavailable
          description: >-
            Unavailable when the page's host is no longer this company's
            storefront.
        url:
          type:
            - string
            - 'null'
          maxLength: 2048
          description: The https URL that was requested; null when unavailable.
        final_url:
          type:
            - string
            - 'null'
          maxLength: 2048
          description: The URL read after redirects; null when unavailable.
        observed_at:
          type:
            - string
            - 'null'
          description: When the page was fetched or captured; null when unavailable.
        title:
          type:
            - string
            - 'null'
          maxLength: 300
          description: The page title from a text read; null for a screenshot.
        viewport:
          type:
            - object
            - 'null'
          description: The emulated viewport of a screenshot; null for a text read.
          additionalProperties: false
          properties:
            name:
              type: string
              enum:
                - mobile
                - desktop
            width:
              type:
                - integer
                - 'null'
            height:
              type:
                - integer
                - 'null'
        screenshot_url:
          type:
            - string
            - 'null'
          maxLength: 4096
          description: >-
            The saved screenshot: the ImageKit URL of its DAM image asset while
            the asset is kept, or, for a capture saved in the private bucket
            before DAM storage, a signed URL valid for about ten minutes. Null
            for a text read or when the screenshot is unavailable.
    MistProductSummary:
      type: object
      description: Product facts as the API answered them; a missing value stays null.
      additionalProperties: false
      required:
        - title
        - sku
        - status
        - active
        - price
        - currency_code
        - in_stock
        - image_url
        - updated_at
      properties:
        title:
          type:
            - string
            - 'null'
          maxLength: 128
        sku:
          type:
            - string
            - 'null'
          maxLength: 128
        status:
          type:
            - string
            - 'null'
          maxLength: 128
        active:
          type:
            - boolean
            - 'null'
        price:
          type:
            - string
            - 'null'
          maxLength: 128
        currency_code:
          type:
            - string
            - 'null'
          maxLength: 128
        in_stock:
          type:
            - boolean
            - 'null'
        image_url:
          type:
            - string
            - 'null'
          description: Present only for an image on the approved image origin.
        updated_at:
          type:
            - string
            - 'null'
          maxLength: 128
    MistOrderSummary:
      type: object
      description: Order facts as the API answered them; a missing value stays null.
      additionalProperties: false
      required:
        - order_number
        - status
        - financial_status
        - fulfillment_status
        - created_at
        - customer_name
        - amount
        - currency_code
        - items_count
        - items
      properties:
        order_number:
          type:
            - string
            - 'null'
          maxLength: 128
        status:
          type:
            - string
            - 'null'
          maxLength: 128
        financial_status:
          type:
            - string
            - 'null'
          maxLength: 128
        fulfillment_status:
          type:
            - string
            - 'null'
          maxLength: 128
        created_at:
          type:
            - string
            - 'null'
          maxLength: 128
        customer_name:
          type:
            - string
            - 'null'
          maxLength: 128
        amount:
          type:
            - string
            - 'null'
          maxLength: 128
        currency_code:
          type:
            - string
            - 'null'
          maxLength: 128
        items_count:
          type:
            - integer
            - 'null'
        items:
          type: array
          maxItems: 10
          items:
            type: object
            additionalProperties: false
            required:
              - title
              - quantity
            properties:
              title:
                type:
                  - string
                  - 'null'
                maxLength: 128
              quantity:
                type:
                  - integer
                  - 'null'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````

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