Bridge Town guides API

openapi: 3.1.0
info:
  title: Bridge Town guides API
  version: '2026-11-03'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-03: 27 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Bridge Town has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 28
    pages-with-code: 6
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-03'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.bridgetown.builders/docs/guides/admin-security-api-cli
  - https://www.bridgetown.builders/docs/guides/bsheet-reader-compatibility
  - https://www.bridgetown.builders/docs/guides/excel-workbook-conversion
  - https://www.bridgetown.builders/docs/guides/github-actions-ci
  - https://www.bridgetown.builders/docs/guides/output-lineage-authoring
  - https://www.bridgetown.builders/docs/guides/team-collaboration
  x-docs-section: guides
servers:
- url: https://api.bridgetown.builders
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl as the command-line client: \n Terminal window export BRIDGE_TOWN_API = \" https://api.bridgetown.builders \" export BRIDGE_TOWN_TOKEN\
          \ = \" btk_... \" \n Pass credentials in the Authorization header. Do not place API tokens, Auth0 access tokens, CMK ARNs, or private\
          \ endpoint URLs in query strings. \n Authorization Section titled “Authorization” \n Operation group Minimum role Plan API tokens Authenti"
  /Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.5.0/native_sheet_reader.py:
    get:
      operationId: get_Bridge_Town_financial_modeling_mcp_releases_download_model_authoring_helpers
      tags:
      - Bridge Town
      summary: Repair a Legacy BSheet Reader
      x-source: https://www.bridgetown.builders/docs/guides/bsheet-reader-compatibility
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.7.0/output_lineage.py:
    get:
      operationId: get_Bridge_Town_financial_modeling_mcp_releases_download_model_authoring_helpers
      tags:
      - Bridge Town
      summary: GET /Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.7.0/output_lineage.py
      x-source: https://www.bridgetown.builders/docs/guides/output-lineage-authoring
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fL -o output_lineage.py \\ https://github.com/Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.7.0/output_lineage.py\
          \ printf ' %s %s\\n ' \\ 772db088d3038654ecb92c729a993da998f1b608fd8b8dcaddaa35c6b6c453e9 \\ output_lineage.py | sha256sum --check \n\
          \ Copy the verified file byte-for-byte into the model repository as\n lib/output_lineage.py using create_file or a one-ent"
  /Bridge-Town/financial-modeling-mcp/releases/download/{downloadid}/bsheet_reader.py:
    get:
      operationId: get_Bridge_Town_financial_modeling_mcp_releases_download_downloadid_bsheet_reade
      tags:
      - Bridge Town
      summary: GET /Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.5.0/bsheet_reader.py
      x-source: https://www.bridgetown.builders/docs/guides/bsheet-reader-compatibility
      parameters:
      - name: downloadid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -fL -o " $tmp_dir /bsheet_reader.py " \ https://github.com/Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.5.0/bsheet_reader.py
          curl -fL -o " $tmp_dir /native_sheet_reader.py " \ https://github.com/Bridge-Town/financial-modeling-mcp/releases/download/model-authoring-helpers-v1.5.0/native_sheet_reader.py
          printf ' %s %s\n ' \ c431799998019c63b7639aa09ba4d9e97a046
        collapsed_from: 2 example path(s) differing only at downloadId
  /api/admin/cmk:
    delete:
      operationId: delete_api_admin_cmk
      tags:
      - Api
      summary: Revoke a CMK
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_admin_cmk
      tags:
      - Api
      summary: Read CMK status
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_admin_cmk
      tags:
      - Api
      summary: Enroll a CMK
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAdminCmkRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/admin/gitea-endpoint:
    delete:
      operationId: delete_api_admin_gitea_endpoint
      tags:
      - Api
      summary: Disable a Gitea endpoint
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_admin_gitea_endpoint
      tags:
      - Api
      summary: Read Gitea endpoint status
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_admin_gitea_endpoint
      tags:
      - Api
      summary: Enroll a Gitea endpoint
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAdminGiteaEndpointRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/feed:
    get:
      operationId: get_api_feed
      tags:
      - Api
      summary: Open /dashboard in the web app, or call GET /api/feed, to see activity from people you follow.
      x-source: https://www.bridgetown.builders/docs/guides/team-collaboration
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFeedResponse'
      x-evidence:
        kind: documentation
  /api/invites:
    post:
      operationId: post_api_invites
      tags:
      - Api
      summary: Invite a member
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiInvitesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/members:
    get:
      operationId: get_api_members
      tags:
      - Api
      summary: List members and invitations
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/members/{userId}:
    delete:
      operationId: delete_api_members_userId
      tags:
      - Api
      summary: Remove a member
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_members_userId
      tags:
      - Api
      summary: Change a member role
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiMembersUseridRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/models/{modelName}/excel-conversions/upload-sessions:
    post:
      operationId: post_api_models_modelName_excel_conversions_upload_sessions
      tags:
      - Api
      summary: The agent requests an upload session to obtain an upload_url, a staged_upload_id, and an expiry time.
      x-source: https://www.bridgetown.builders/docs/guides/excel-workbook-conversion
      parameters:
      - name: modelName
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiModelsModelnameExcelConversionsUploadSessionsResponse'
      x-evidence:
        kind: documentation
  /api/models/{modelName}/runs:
    post:
      operationId: post_api_models_modelName_runs
      tags:
      - Api
      summary: Uploads the result of a model run to the Bridge Town platform.
      x-source: https://www.bridgetown.builders/docs/guides/github-actions-ci
      parameters:
      - name: modelName
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiModelsModelnameRunsResponse'
      x-evidence:
        kind: documentation
  /api/models/{modelName}/template:
    delete:
      operationId: delete_api_models_modelName_template
      tags:
      - Api
      summary: Unpublish a template
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      parameters:
      - name: modelName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_models_modelName_template
      tags:
      - Api
      summary: Publish a template
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      parameters:
      - name: modelName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiModelsModelnameTemplateRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/notifications/{notificationId}:
    delete:
      operationId: delete_api_notifications_notificationId
      tags:
      - Api
      summary: Dismiss an invite notification once you have acted on it.
      x-source: https://www.bridgetown.builders/docs/guides/team-collaboration
      parameters:
      - name: notificationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/tenant:
    get:
      operationId: get_api_tenant
      tags:
      - Api
      summary: Read tenant settings
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_tenant
      tags:
      - Api
      summary: Update tenant settings
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiTenantRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/tenant/settings:
    get:
      operationId: get_api_tenant_settings
      tags:
      - Api
      summary: Read tenant settings
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_tenant_settings
      tags:
      - Api
      summary: Update tenant settings
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiTenantSettingsRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/tokens:
    get:
      operationId: get_api_tokens
      tags:
      - Api
      summary: List API tokens
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_tokens
      tags:
      - Api
      summary: Create an API token
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiTokensRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/tokens/{tokenId}:
    delete:
      operationId: delete_api_tokens_tokenId
      tags:
      - Api
      summary: Revoke an API token
      x-source: https://www.bridgetown.builders/docs/guides/admin-security-api-cli
      parameters:
      - name: tokenId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    PostRequest:
      type: object
      properties:
        name:
          type: string
        expires_in:
          type: integer
    PostApiAdminCmkRequest:
      type: object
      properties:
        cmk_arn:
          type: string
      required:
      - cmk_arn
    PostApiAdminGiteaEndpointRequest:
      type: object
      properties:
        gitea_url:
          type: string
      required:
      - gitea_url
    GetApiFeedResponse:
      type: object
      properties:
        items:
          type: array
          description: Reverse-chronological activity events from users you follow.
        notifications:
          type: array
          description: Undismissed invite notifications for workspace or model invites sent to you.
    PostApiInvitesRequest:
      type: object
      properties:
        email:
          type: string
        role:
          type: string
      required:
      - email
      - role
    PatchApiMembersUseridRequest:
      type: object
      properties:
        role:
          type: string
      required:
      - role
    PostApiModelsModelnameExcelConversionsUploadSessionsResponse:
      type: object
      properties:
        upload_url:
          type: string
          description: A short‑lived, single‑use URL where the user can upload the workbook file.
        staged_upload_id:
          type: string
          description: Identifier used by the agent to continue the conversion without passing workbook bytes.
        expiry:
          type: string
          description: Expiration time of the upload session (default 30 minutes).
    PostApiModelsModelnameRunsResponse:
      type: object
      properties:
        run_id:
          type: string
          description: Identifier of the created run.
        status:
          type: string
          description: Result status (e.g., success).
        exit_code:
          type: integer
          description: CLI exit code for the run.
        duration_seconds:
          type: number
          description: Duration of the run in seconds.
        branch:
          type: string
          description: Branch or scenario used for the run.
        commit_sha:
          type: string
          description: Git commit SHA associated with the run.
        platform_url:
          type: string
          description: URL to view the run on Bridge Town.
    PutApiModelsModelnameTemplateRequest:
      type: object
      properties:
        template_description:
          type: string
      required:
      - template_description
    PatchApiTenantRequest:
      type: object
      properties:
        run_retention_months:
          type: integer
      required:
      - run_retention_months
    PatchApiTenantSettingsRequest:
      type: object
      properties:
        run_retention_months:
          type: integer
      required:
      - run_retention_months
    PostApiTokensRequest:
      type: object
      properties:
        name:
          type: string
        expires_in:
          type: integer
      required:
      - name
      - expires_in
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Bridge Town