Basedash API

openapi: 3.1.0
info:
  title: Basedash API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 9 operation(s) read from 10 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Basedash has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 12
    documentation: -3
    pages-with-code: 10
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.basedash.com/docs/api-reference/overview
  - https://www.basedash.com/docs/api-reference/billing-accounts/list-billing-accounts
  - https://www.basedash.com/features/mcp-server
  - https://www.basedash.com/features/self-hosting
  - https://www.basedash.com/features/automations
  - https://www.basedash.com/docs/api-reference/billing-accounts/get-a-billing-account
  - https://www.basedash.com/docs/api-reference/billing-accounts/list-attached-organizations
  - https://www.basedash.com/docs/api-reference/billing-accounts/attach-an-organization
  - https://www.basedash.com/docs/api-reference/billing-accounts/detach-an-organization
  - https://www.basedash.com/docs/api-reference/billing-accounts/get-pooled-ai-usage
servers:
- url: https://charts.basedash.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://www.basedash.com/features/self-hosting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://<hub>/api/v1/connect?targetId=<id>&targetSecret=<secret>\"  | docker compose -f - up -d \n ✔ Container distr-agent-1\
          \ Started"
  /api/public/billing-accounts:
    get:
      operationId: get_api_public_billing_accounts
      tags:
      - Api
      summary: GET /api/public/billing-accounts
      x-source: https://www.basedash.com/docs/api-reference/billing-accounts/list-billing-accounts
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicBillingAccountsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl --request GET  --url https://charts.basedash.com/api/public/billing-accounts  --header ''Authorization: Bearer <token>''
          import requests

          url = "https://charts.basedash.com/api/public/billing-accounts"

          headers = {"Authorization": "Bearer <token>"}

          response = requests.get(url, headers=headers)

          print(response.text) const options = {method: ''GET'', headers: {Authorization: ''Bearer <token>''}};

          f'
  /api/public/billing-accounts/{billingaccountid}/organizations/{orgid}:
    get:
      operationId: get_api_public_billing_accounts_billingaccountid_organizations_orgid
      tags:
      - Api
      summary: GET /api/public/billing-accounts/{billingaccountid}/organizations/{orgid}
      x-source: https://www.basedash.com/docs/api-reference/billing-accounts/detach-an-organization
      parameters:
      - name: billingaccountid
        in: path
        required: true
        schema:
          type: string
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicBillingAccountsBillingaccountidOrganizationsOrgi'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl);\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n} package main\nimport (\n \"fmt\"\n \"net/http\"\
          \n \"io\"\n)\nfunc main() {\n url := \"https://charts.basedash.com/api/public/billing-accounts/{billingAccountId}/organizations/{orgId}\"\
          \n req, _ := http.NewRequest(\"DELETE\", url, nil)\n req.Header.Add(\"Authorization\", \"Bearer <token>\")\n res, _ := http.DefaultClient.Do(req)\n\
          \ defer res.Body.C"
  /api/public/mcp:
    post:
      operationId: post_api_public_mcp
      tags:
      - Api
      summary: POST /api/public/mcp
      x-source: https://www.basedash.com/features/mcp-server
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPublicMcpRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST  \".../chats?wait=120\"  -H \"Authorization: Bearer bd_key_…\"  -d '{\"message\": \"Active teams by plan?\"}' \n\
          \ 201 \"status\" : \"finished\" #customer-success Thread Dana @Basedash how many teams were active last week, by plan? Basedash 235\
          \ active teams. Scale leads with 82. Starter 38 Growth 64 Scale 82 Enterprise 51 \n What's included \n E v e r y t h i n g t h a t c\
          \ o m e s w i t h o n e c o n "
  /api/public/organizations:
    post:
      operationId: post_api_public_organizations
      tags:
      - Api
      summary: POST /api/public/organizations
      x-source: https://www.basedash.com/docs/api-reference/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPublicOrganizationsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPublicOrganizationsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://charts.basedash.com/api/public/organizations  -H \"Authorization: Bearer <basedash_api_key>\"  -H \"Content-Type:\
          \ application/json\"  -d '{\"name\": \"My Organization\"}' \n ​ Request format \n All requests with a body should use Content-Type:\
          \ application/json . \n Request bodies should be valid JSON. \n ​ Response format \n All responses use a standardized wrapper format\
          \ for consistency. "
  /api/public/organizations/{orgid}/automations/{id}/runs:
    post:
      operationId: post_api_public_organizations_orgid_automations_id_runs
      tags:
      - Api
      summary: Start a run
      x-source: https://www.basedash.com/features/automations
      parameters:
      - name: orgid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPublicOrganizationsOrgidAutomationsIdRunsResponse'
      x-evidence:
        kind: documentation
  /api/v1/connect:
    get:
      operationId: get_api_v1_connect
      tags:
      - Api
      summary: Self-hosted Basedash
      x-source: https://www.basedash.com/features/self-hosting
      parameters:
      - name: targetId
        in: query
        required: true
        schema:
          type: string
      - name: targetSecret
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /health:
    get:
      operationId: get_health
      tags:
      - Health
      summary: GET /health
      x-source: https://www.basedash.com/features/self-hosting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i https://basedash.acme.internal/health \n HTTP/1.1 200 OK "
  /png:
    post:
      operationId: post_png
      tags:
      - Png
      summary: POST /png
      x-source: https://www.basedash.com/features/automations
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPngResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \\ -H \"Authorization: Bearer $BASEDASH_API_KEY\" \\ \"$API/organizations/$ORG_ID/automations/$ID/runs\" GET …/runs/chat_7Qm2xV\
          \ 200 OK { \"data\" : { \"id\" : \"chat_7Qm2xV\" , \"status\" : \"FINISHED\" , \"isManualRun\" : true , \"finalMessageContent\" : \"\
          ## Pipeline grew 9% to $1.42M…\" , \"charts\" : [{ \"imageUrl\" : \"https://…/png\" }] } } \n Templates \n S t a r t f r o m a t e m\
          \ p l a t e , n o t a b l a "
components:
  schemas:
    GetApiPublicBillingAccountsResponse:
      type: object
      properties:
        method:
          type: string
        headers:
          type: object
          properties:
            Authorization:
              type: string
    GetApiPublicBillingAccountsBillingaccountidOrganizationsOrgi:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            billingAccountId:
              type: string
            detached:
              type: boolean
    PostApiPublicMcpRequest:
      type: object
      properties:
        message:
          type: string
    PostApiPublicOrganizationsRequest:
      type: object
      properties:
        name:
          type: string
    PostApiPublicOrganizationsResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            slug:
              type: string
            customAiContext:
              type:
              - string
              - 'null'
            onboardingStatus:
              type: string
    PostApiPublicOrganizationsOrgidAutomationsIdRunsResponse:
      type: object
      properties:
        data.id:
          type: string
          description: Run identifier
        data.status:
          type: string
          description: Run status, e.g., FINISHED
        data.isManualRun:
          type: boolean
          description: Indicates if the run was started manually
        data.finalMessageContent:
          type: string
          description: Markdown content of the final message
        data.charts:
          type: array
          description: List of chart objects
        data.charts[].imageUrl:
          type: string
          description: URL to the chart image (png)
    PostPngResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            status:
              type: string
            isManualRun:
              type: boolean
            finalMessageContent:
              type: string
            charts:
              type: array
              items:
                type: object
                properties:
                  imageUrl:
                    type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Health
- name: Png