Bidda API

openapi: 3.1.0
info:
  title: Bidda API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 10 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Bidda has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 7
    documentation: 3
    pages-with-code: 3
    pages-read: 5
  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://bidda.com/developers
  - https://bidda.com/methodology
  - https://bidda.com/mitre
  - https://bidda.com/sylva-codex
  - https://bidda.com/audit
paths:
  /api/v1/nodes/{node_id}.json:
    get:
      operationId: get_api_v1_nodes_node_id_json
      tags:
      - Api
      summary: Single discovery node
      description: Returns the full payload for a single discovery node.
      x-source: https://bidda.com/sylva-codex
      parameters:
      - name: node_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/oscal/catalog.json:
    get:
      operationId: get_api_v1_oscal_catalog_json
      tags:
      - Api
      summary: GET /api/v1/oscal/catalog.json
      x-source: https://bidda.com/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://bidda.com/api/v1/oscal/catalog.json Common Integration Patterns \n The most common ways developers plug Bidda into\
          \ their stacks. All examples use public endpoints only - no proprietary logic is exposed. \n LangChain Tool OpenAI Functions Batch Fetch\
          \ 402 Retry Loop Direct USDC Wrap a Bidda vault call as a LangChain Tool. The agent calls discover_bidda_node when it needs to verify\
          \ a regul"
  /api/v1/registry-health.json:
    get:
      operationId: get_api_v1_registry_health_json
      tags:
      - Api
      summary: GET /api/v1/registry-health.json
      x-source: https://bidda.com/developers
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1RegistryHealthJsonResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://bidda.com/api/v1/registry-health.json \n Example response shape (counts illustrative): \n { \"last_check_completed\"\
          : \"2026-05-25T02:00:00Z\", \"next_scheduled_check\": \"2026-06-01T02:00:00Z\", \"registry_total_nodes\": 10102, \"unique_primary_sources_tracked\"\
          : 3648, \"sources_with_changes_in_last_7_days\": 3, \"last_check_summary\": { \"unchanged\": 3641, \"content_changed\": 2, \"tls_changed\"\
          : 1, \"fetc"
  /api/v1/transparency/consistency?first=&second=:
    get:
      operationId: get_api_v1_transparency_consistency_first_second
      tags:
      - Api
      summary: Proof the log only ever grew - append-only, tamper-evident.
      x-source: https://bidda.com/developers
      parameters:
      - name: first
        in: query
        required: true
        schema:
          type: string
        description: First tree size or hash.
      - name: second
        in: query
        required: true
        schema:
          type: string
        description: Second tree size or hash.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/transparency/entries:
    get:
      operationId: get_api_v1_transparency_entries
      tags:
      - Api
      summary: The raw leaf list, for auditors mirroring the log.
      x-source: https://bidda.com/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/transparency/proof?record_id=:
    get:
      operationId: get_api_v1_transparency_proof_record_id
      tags:
      - Api
      summary: Inclusion proof for one record, foldable to the signed root.
      x-source: https://bidda.com/developers
      parameters:
      - name: record_id
        in: query
        required: true
        schema:
          type: string
        description: Identifier of the record to prove inclusion for.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/transparency/sth:
    get:
      operationId: get_api_v1_transparency_sth
      tags:
      - Api
      summary: The current signed tree head - size, root, signature.
      x-source: https://bidda.com/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/vault/nodes/{node_id}.json:
    get:
      operationId: get_api_v1_vault_nodes_node_id_json
      tags:
      - Api
      summary: Vault tier (paid $0.01)
      description: Returns the vault‑tier version of a node (requires paid access).
      x-source: https://bidda.com/sylva-codex
      parameters:
      - name: node_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /mcp:
    post:
      operationId: post_mcp
      tags:
      - Mcp
      summary: Agent integration (free, no key required)
      description: Returns the Bidda compliance node, the regulatory controls it maps to, and any D3FEND techniques that counter it.
      x-source: https://bidda.com/mitre
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMcpRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostMcpResponse'
      x-evidence:
        kind: documentation
  /scan:
    post:
      operationId: post_scan
      tags:
      - Scan
      summary: Scan source code or text and receive a ranked list of regulatory node matches with risk level.
      x-source: https://bidda.com/developers
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostScanRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostScanResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1RegistryHealthJsonResponse:
      type: object
      properties:
        last_check_completed:
          type: string
          format: date-time
        next_scheduled_check:
          type: string
          format: date-time
        registry_total_nodes:
          type: integer
        unique_primary_sources_tracked:
          type: integer
        sources_with_changes_in_last_7_days:
          type: integer
        last_check_summary:
          type: object
          properties:
            unchanged:
              type: integer
            content_changed:
              type: integer
            tls_changed:
              type: integer
            fetch_failed:
              type: integer
        integrity_attestation:
          type: string
    PostMcpRequest:
      type: object
      properties:
        id:
          type: string
          description: MITRE technique identifier, e.g., "T1566"
      required:
      - id
    PostMcpResponse:
      type: object
      properties:
        compliance_node:
          type: object
          description: The Bidda compliance node
        regulatory_controls:
          type: array
          description: Regulatory controls the node maps to
        d3fend_techniques:
          type: array
          description: D3FEND techniques that counter the node
    PostScanRequest:
      type: object
      properties:
        content:
          type: string
          description: Text or source code to scan (up to 512 KB).
        jurisdiction:
          type: string
          description: Optional jurisdiction filter (e.g., "eu").
        limit:
          type: string
          description: Maximum number of matches to return (default 10, max 25).
    PostScanResponse:
      type: object
      properties:
        ok:
          type: boolean
        risk_level:
          type: string
        matches:
          type: array
        summary:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-bidda-api-key
security:
- apiKey: []
tags:
- name: Api
- name: Mcp
- name: Scan