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

# Complete a workout v2 session

> A client completing an exercise-based assigned or freestyle session must first save at least one completed set belonging to that session and client/company. Otherwise SESSION_COMPLETED_SET_REQUIRED (400) leaves the session open without completion side effects. Prescribed metrics and exercise-level isCompleted flags do not qualify. Explicit coach completion, score-based WODs, genuinely exercise-free plan days and retries of already-completed sessions keep their existing behavior.

Requires the workout_sessions:write scope. This operation maps to /app/v1/workout/performance/sessions/:sessionId/complete and retains its Workout V2 permission, feature-flag, and resource-scope checks.

The clientId path parameter is resolved inside the company bound to the Public API token when present.



## OpenAPI

````yaml /openapi/public-v1.json patch /public/v1/workout/performance/sessions/{sessionId}/complete
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Developer Public API endpoints under `/public/v1`. This reference is
    filtered to OAuth/Bearer Public API resources and excludes provider callback
    receivers, storefront routes, public widgets, wishlist routes, and
    access-device validation endpoints.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Workout
    description: >-
      Workout V2 libraries, programmes, client plans, calendars, sessions,
      groups, settings and progress. AI operations are excluded.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Health
    description: Public API token health checks.
  - name: Platform
    description: >-
      Inspect Public API client context, capabilities, scopes, and redacted
      audit logs.
  - name: Company Catalog
    description: Read and manage company profile metadata and locations.
  - name: Clients
    description: >-
      Create and manage clients through the Public API using Bearer access
      tokens.
  - name: Coaches
    description: Retrieve coaches for the authenticated company via integrations.
  - name: Calendar Events
    description: Read Public API calendar events.
  - name: Calendar Templates
    description: >-
      Read and manage event types and event templates used by calendar
      availability and bookings.
  - name: Calendar Extensions
    description: >-
      Read recurring bookings, booking requests, calendar tasks, and
      availability closure metadata.
  - name: Availability
    description: Read bookable availability slots and signed availability tokens.
  - name: Availability Management
    description: >-
      Manage coach and location availability templates used to derive bookable
      slots.
  - name: Bookings
    description: Read and manage Public API bookings.
  - name: Finance
    description: >-
      Read invoices, transactions, products, subscriptions, and memberships with
      guarded finance writes.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations, mutations, and
      guarded credit adjustments.
  - name: Exports
    description: >-
      Create and monitor asynchronous company exports through Public API Bearer
      endpoints.
  - name: Webhooks
    description: >-
      Manage outbound webhook subscriptions and inspect delivery attempts
      through Public API Bearer endpoints.
  - name: Measurements
    description: Read and write client measurement entries.
  - name: Progress Photos
    description: Read client progress photo metadata and short-lived signed media URLs.
  - name: Forms
    description: Read, create, update, and archive company form templates.
  - name: Intakes
    description: Assign intake forms and read client intake assignments and submissions.
  - name: Check-ups
    description: >-
      Schedule and cancel client check-ups and read their status and
      submissions.
  - name: Documents
    description: >-
      Read client document and folder metadata, register external document
      links, update metadata, and archive documents from Public API listings.
      Binary upload, permanent deletion, and company-wide document management
      are not exposed.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Conversations
    description: >-
      Read and manage direct and group chat conversations through the Public
      API.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
paths:
  /public/v1/workout/performance/sessions/{sessionId}/complete:
    patch:
      tags:
        - Workout
      summary: Complete a workout v2 session
      description: >-
        A client completing an exercise-based assigned or freestyle session must
        first save at least one completed set belonging to that session and
        client/company. Otherwise SESSION_COMPLETED_SET_REQUIRED (400) leaves
        the session open without completion side effects. Prescribed metrics and
        exercise-level isCompleted flags do not qualify. Explicit coach
        completion, score-based WODs, genuinely exercise-free plan days and
        retries of already-completed sessions keep their existing behavior.


        Requires the workout_sessions:write scope. This operation maps to
        /app/v1/workout/performance/sessions/:sessionId/complete and retains its
        Workout V2 permission, feature-flag, and resource-scope checks.


        The clientId path parameter is resolved inside the company bound to the
        Public API token when present.
      operationId: publicWorkoutpatchPublicV1WorkoutPerformanceSessionsSessionIdComplete
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
            example: booking-create-20260714-001
          description: >-
            Required for Public API write requests. Reusing the same key with
            the same method, path, and body replays the stored successful
            response; reusing it with a different request returns `409
            idempotency.conflict`.
        - in: path
          name: sessionId
          required: true
          description: Workout session id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdCompleteRequest
            examples:
              forTime:
                summary: For Time day finished under the cap
                value:
                  wodResult:
                    elapsedSeconds: 742
                    finishedBeforeCap: true
                    totalReps: 150
              amrap:
                summary: AMRAP day
                value:
                  wodResult:
                    roundsCompleted: 5
                    repsPerRound: 30
                    extraReps: 12
                    totalReps: 162
      responses:
        '200':
          description: Scored plan day completed; `scoring.result` is the saved score.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiWriteSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdCompleteResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      sessionId: 67f1234567890abcdef1234
                      scoring:
                        scoringType: forTime
                        descriptionOnly: true
                        acceptsManualResult: true
                        targetValue: null
                        timeDomain:
                          windowSeconds: null
                          timeCapSeconds: 900
                          rounds: 3
                          intervalSeconds: null
                          intervalCount: null
                          workSeconds: null
                          restSeconds: null
                        scoreValidation:
                          timeCapSeconds: 900
                          maxReps: null
                          expectedIntervals: null
                        result:
                          roundsCompleted: 5
                          repsPerRound: 30
                          extraReps: 12
                          totalReps: 162
                          intervalReps:
                            - 12
                            - 11
                            - 10
                          elapsedSeconds: 742
                          finishedBeforeCap: true
                          timeCapSeconds: 900
                          maxLoadKg: 120
                      leaderboardEntryId: 67f1234567890abcdef1234
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                      idempotency:
                        replayed: false
        '204':
          description: >-
            Session completed. Runtime still returns the standard response
            envelope without a `data` property.
          content:
            application/json: {}
        '400':
          description: >-
            Session id is invalid, the client has no saved completed set
            (SESSION_COMPLETED_SET_REQUIRED), or the manual score is
            missing/invalid (WOD_RESULT_REQUIRED, WOD_RESULT_INVALID,
            WOD_RESULT_INVALID_FIELDS, WOD_RESULT_NOT_ALLOWED,
            WOD_RESULT_TIME_REQUIRED, WOD_RESULT_REPS_REQUIRED, ...).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                invalidRequest:
                  summary: Invalid request
                  value:
                    error:
                      code: 400
                      key: request.invalid
                      message: The request is invalid.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyRequired:
                  summary: Missing Idempotency-Key
                  value:
                    error:
                      code: 400
                      key: idempotency.required
                      message: >-
                        Idempotency-Key header is required for Public API write
                        requests.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyInvalid:
                  summary: Invalid Idempotency-Key
                  value:
                    error:
                      code: 400
                      key: idempotency.invalid
                      message: Idempotency-Key header must be 200 characters or fewer.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '401':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                missingBearer:
                  summary: Missing Bearer token
                  value:
                    error:
                      code: 401
                      key: auth.missing_bearer
                      message: Authorization Bearer token is required.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidToken:
                  summary: Invalid or expired token
                  value:
                    error:
                      code: 401
                      key: auth.invalid_token
                      message: The access token is invalid or expired.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidClient:
                  summary: Inactive or revoked client
                  value:
                    error:
                      code: 401
                      key: auth.invalid_client
                      message: The Public API client is inactive or revoked.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '403':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                insufficientScopes:
                  summary: Missing required scope
                  value:
                    error:
                      code: 403
                      key: scopes.insufficient
                      message: The access token does not include the required scope.
                      details:
                        requiredScopes:
                          - required:scope
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: Session was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                notFound:
                  summary: Resource not found
                  value:
                    error:
                      code: 404
                      key: resource.not_found
                      message: The requested Public API resource was not found.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '409':
          description: The session is awaiting restart/continue confirmation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                idempotencyConflict:
                  summary: Idempotency-Key conflict
                  value:
                    error:
                      code: 409
                      key: idempotency.conflict
                      message: >-
                        Idempotency-Key was already used with a different
                        request.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyInProgress:
                  summary: Idempotency-Key in progress
                  value:
                    error:
                      code: 409
                      key: idempotency.in_progress
                      message: >-
                        Idempotency-Key is already processing for this Public
                        API client.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '422':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                emptyBody:
                  summary: Empty or invalid JSON object body
                  value:
                    error:
                      code: 422
                      key: EMPTY_BODY
                      message: Request body must be a non-empty JSON object.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '429':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                rateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error:
                      code: 429
                      key: rate_limit.exceeded
                      message: Too many Public API requests. Retry later.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 0
                        resetSeconds: 1
                        retryAfterSeconds: 1
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                serverInternalError:
                  summary: Unexpected server error
                  value:
                    error:
                      code: 500
                      key: server.internal_error
                      message: An unexpected Public API server error occurred.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
      security:
        - PublicBearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: >-
            curl -X PATCH
            "https://api.fitsociety.io/public/v1/workout/performance/sessions/{sessionId}/complete"
            \
              -H "Authorization: Bearer <access_token>" \
              -H "Idempotency-Key: <stable_request_key>" \
              -H "Content-Type: application/json" \
              -d '{}'
components:
  schemas:
    PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdCompleteRequest:
      type: object
      properties:
        notes:
          type: string
          example: Session felt good overall.
        clientId:
          type: string
          description: >-
            Required when a coach completes on a client's behalf. A client token
            completes its own session and may omit it.
          example: 67f1234567890abcdef1111
        askForFeedback:
          type: boolean
          default: false
          description: >-
            The "Ask <client> for feedback" toggle. When `true` AND the caller
            is a coach, the client is sent a push notification asking them to
            submit feedback, in their own language (en, nl, fr, de, es). Sent
            for plan days and freestyle sessions only: the title is the plan
            name for a plan-linked session, or "Freestyle Workout" for a
            genuinely ad-hoc one (no plan, WOD or group attachment — the same
            test the freestyle history feed uses). A WOD or group run sends
            nothing at all, since neither is described by this copy. Its data
            payload carries `type: "workout_feedback_request"`, `sessionId`,
            `clientId`, `companyId`, `historyType` and `dayTitle`, so tapping it
            opens the workout-day history screen. `historyType` is `"plan"` or
            `"freestyle"` and is ALWAYS present — branch on it rather than
            inferring the kind from `dayTitle`. `dayTitle` is the plan day's
            name, or the freestyle history feed's own "Freestyle Workout N"
            label (the client's own session name when they set one); it is
            omitted when neither applies. Ignored when a client completes their
            own session, since the copy states the coach completed it. A push
            failure is logged and never fails the completion.
          example: true
        wodResult:
          allOf:
            - $ref: '#/components/schemas/PublicWorkoutSourceWorkoutManualWodResult'
          description: >-
            Manual score for an exercise-free scored plan day
            (`scoring.acceptsManualResult` on the day). Required to complete
            such a day, whoever completes it (client or coach); without it the
            call fails with WOD_RESULT_REQUIRED and the session stays open.
            Group-run and feedback auto-completion apply the same rule, so
            complete a scored day here first. Rejected with
            WOD_RESULT_NOT_ALLOWED on any other session (WOD sessions complete
            via PATCH /app/v1/wod/{id}/complete). The score and the completion
            are saved in one write. Once the session is completed its score is
            final: a retry returns the stored score and ignores any new one.
    PublicApiWriteSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiWriteMeta'
    PublicWorkoutSourcePATCHAppV1WorkoutPerformanceSessionsSessionIdCompleteResponse200:
      type: object
      description: >-
        Returned only for an exercise-free scored plan day; every other session
        keeps the empty 204.
      properties:
        sessionId:
          type: string
          example: 67f1234567890abcdef1234
        scoring:
          type: object
          nullable: true
          description: >-
            Scoring of a plan day. Null for an ordinary standard day.
            `acceptsManualResult` is true only for exercise-free scored days
            (`descriptionOnly`), which take a `wodResult` on PATCH
            /app/v1/workout/performance/sessions/{sessionId}/complete. `result`
            is the saved score of the selected session, or null.
          properties:
            scoringType:
              type: string
              enum:
                - standard
                - forTime
                - amrap
                - emom
                - tabata
                - maxLoad
              example: forTime
            descriptionOnly:
              type: boolean
              example: true
            acceptsManualResult:
              type: boolean
              example: true
            targetValue:
              type: number
              nullable: true
              example: null
            timeDomain:
              type: object
              nullable: true
              description: >-
                Clock prescription, same contract as a WOD `timeDomain`. Allowed
                fields depend on `scoringType`: amrap → windowSeconds
                (required); forTime → timeCapSeconds, rounds (defaults to 1);
                emom → intervalSeconds, intervalCount (both required); tabata →
                workSeconds, restSeconds, intervalCount (all required);
                standard/maxLoad → none.
              properties:
                windowSeconds:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: null
                timeCapSeconds:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: 900
                rounds:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: 3
                intervalSeconds:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: null
                intervalCount:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: null
                workSeconds:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: null
                restSeconds:
                  type: integer
                  nullable: true
                  minimum: 0
                  example: null
            scoreValidation:
              type: object
              nullable: true
              description: >-
                Optional result caps. timeCapSeconds and expectedIntervals are
                derived from `timeDomain` when one is set.
              properties:
                timeCapSeconds:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: 900
                maxReps:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: null
                expectedIntervals:
                  type: integer
                  nullable: true
                  minimum: 1
                  example: null
            result:
              allOf:
                - type: object
                  description: >-
                    Type-specific manual score, the same shape as the WOD
                    `wodResult`. Only the fields of the day's scoringType are
                    accepted: amrap → roundsCompleted, repsPerRound, extraReps,
                    totalReps (total = rounds × repsPerRound + extraReps,
                    extraReps < repsPerRound); forTime → elapsedSeconds,
                    finishedBeforeCap, totalReps (reps required when not
                    finished before the cap); emom/tabata → intervalReps,
                    totalReps (sum of intervals; count must match intervalCount
                    when set); maxLoad → maxLoadKg. The stored copy of a forTime
                    result also carries timeCapSeconds.
                  properties:
                    roundsCompleted:
                      type: integer
                      minimum: 0
                      example: 5
                    repsPerRound:
                      type: integer
                      minimum: 1
                      example: 30
                    extraReps:
                      type: integer
                      minimum: 0
                      example: 12
                    totalReps:
                      type: integer
                      minimum: 0
                      example: 162
                    intervalReps:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                      example:
                        - 12
                        - 11
                        - 10
                    elapsedSeconds:
                      type: number
                      minimum: 0
                      example: 742
                    finishedBeforeCap:
                      type: boolean
                      example: true
                    timeCapSeconds:
                      type: integer
                      nullable: true
                      readOnly: true
                      example: 900
                    maxLoadKg:
                      type: number
                      minimum: 0
                      example: 120
              nullable: true
        leaderboardEntryId:
          type: string
          example: 67f1234567890abcdef1234
          nullable: true
    PublicApiError:
      type: object
      additionalProperties: false
      required:
        - error
        - meta
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - key
            - message
          properties:
            code:
              type: integer
              example: 401
            key:
              type: string
              example: auth.invalid_token
            message:
              type: string
              example: The access token is invalid.
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    PublicWorkoutSourceWorkoutManualWodResult:
      type: object
      description: >-
        Type-specific manual score, the same shape as the WOD `wodResult`. Only
        the fields of the day's scoringType are accepted: amrap →
        roundsCompleted, repsPerRound, extraReps, totalReps (total = rounds ×
        repsPerRound + extraReps, extraReps < repsPerRound); forTime →
        elapsedSeconds, finishedBeforeCap, totalReps (reps required when not
        finished before the cap); emom/tabata → intervalReps, totalReps (sum of
        intervals; count must match intervalCount when set); maxLoad →
        maxLoadKg. The stored copy of a forTime result also carries
        timeCapSeconds.
      properties:
        roundsCompleted:
          type: integer
          minimum: 0
          example: 5
        repsPerRound:
          type: integer
          minimum: 1
          example: 30
        extraReps:
          type: integer
          minimum: 0
          example: 12
        totalReps:
          type: integer
          minimum: 0
          example: 162
        intervalReps:
          type: array
          items:
            type: integer
            minimum: 0
          example:
            - 12
            - 11
            - 10
        elapsedSeconds:
          type: number
          minimum: 0
          example: 742
        finishedBeforeCap:
          type: boolean
          example: true
        timeCapSeconds:
          type: integer
          nullable: true
          readOnly: true
          example: 900
        maxLoadKg:
          type: number
          minimum: 0
          example: 120
    PublicApiWriteMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
        idempotency:
          type: object
          additionalProperties: false
          properties:
            replayed:
              type: boolean
              description: >-
                True when the response was replayed from a previous request with
                the same `Idempotency-Key`.
              example: true
    PublicApiMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
    StandardResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        error:
          type: boolean
          example: false
        message:
          type: string
          example: SUCCESS
      required:
        - status
        - error
        - message
    PublicApiRateLimitMeta:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
          example: 10
        remaining:
          type: integer
          example: 9
        resetSeconds:
          type: integer
          description: Seconds until the current rate limit window resets.
          example: 1
        retryAfterSeconds:
          type: integer
          description: Present when the request was rate limited.
          example: 1
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`. Each resource request rechecks the
        token company's current provider access. Disabling access blocks
        existing tokens with `403 auth.provider_unavailable`.

````

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