Boardwalk Documents API

openapi: 3.2.0
info:
  title: Boardwalkai Com Documents API
  version: '2026-09-16'
  contact:
    name: Boardwalk Support
    email: support@boardwalkai.com
    url: https://boardwalkai.com
  description: 'Operations tagged Documents across 2 of this provider''s published API definitions: boardwalkai-com-openapi.json, boardwalkai-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.boardwalkai.com/api/v1
  description: Production
- url: http://localhost:8000/api/v1
  description: Local development
security:
- bearerAuth: []
tags:
- name: Documents
  description: Fetch the source meeting documents projects were extracted from.
paths:
  /documents/{id}:
    get:
      tags:
      - Documents
      summary: Get a single meeting document
      description: 'Returns the full meeting document record: title, meeting date, raw extracted text, structured analysis, and source URL.


        These are the underlying source records that projects were extracted from. `id` values come from `delivery.newEvidence[].meetingDocumentId` on `GET /projects/sync`, which is the only place the customer surface publishes a meeting-document id. Project records on `/projects/search` and `/projects/{id}` carry `sourceDocumentUrl` (a direct link to the filing) rather than a document id, so a caller on those routes alone has no id to send here.


        Only documents that have been through Boardwalk''s current extraction standard are served here; a document that has not been analysed returns `404`. Documents ingested in the last few weeks are the most likely to be in that state.


        **Cost.** County, State, and National: 1 export record the first time this account receives the document, against a shared 100,000 a month. A later read of the same document is free. Standalone API Only and the free trial: 1 credit the first time.'
      parameters:
      - name: id
        in: path
        required: true
        description: Meeting document ID.
        schema:
          type: integer
      responses:
        '200':
          description: Document record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentResponse'
          headers:
            X-Boardwalk-Schema-Version:
              $ref: '#/components/headers/BoardwalkSchemaVersion'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '404':
          description: 'No document is available for this ID: it does not exist, or it has not been analysed. No credits are charged.'
          headers:
            X-Boardwalk-Schema-Version:
              $ref: '#/components/headers/BoardwalkSchemaVersion'
        '409':
          $ref: '#/components/responses/IdempotencyConflict'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
      operationId: getDocumentsById
      x-operation-id-source: derived
    servers:
    - url: https://api.boardwalkai.com/api/v1
      description: Production
    - url: http://localhost:8000/api/v1
      description: Local development
components:
  responses:
    PaymentRequired:
      description: 'Subscription missing, credits exhausted, or the page this request would deliver costs more than the balance has left.


        * `subscription_required`: no active paid plan or trial behind this key.

        * `credits_exhausted`: the balance cannot cover even one record and this response would have billed at least one. Re-reads of unchanged records you already own bill 0 and are still served at 0 balance. Paid balances refill on the 1st; trial credits never do.

        * `insufficient_credits`: the balance has credits left, but fewer than this page would cost. A page is delivered whole or refused whole, never trimmed, so **no records are returned and nothing is charged**. `details.quote` states the page''s cost, what remains, `affordableRecordCount` (the `limit` to retry with), and a free `countUrl` that re-prices the whole match set. Free-trial pages are truncated instead of refused here; see `meta.trialTruncation`.

        * `enrichment_requires_paid_plan`: `include=contacts` (Find Contact Info) needs a paid plan or a live trial. Record credits may still remain. Drop the parameter, start a trial, or upgrade.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: credits_exhausted
              message: You have used all your API credits for this billing period. Credits reset on the 1st of each month.
              param: null
              details:
                creditsUsed: 5000
                creditsLimit: 5000
                resetsAt: '2026-06-01T00:00:00Z'
              docsUrl: https://boardwalkai.com/docs/api/errors#credits_exhausted
              requestId: req_01K1QF3M0000EXAMPLE0001
      headers:
        X-Boardwalk-Schema-Version:
          $ref: '#/components/headers/BoardwalkSchemaVersion'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: missing_api_key
              message: 'API key is required. Include it as Authorization: Bearer bwk_live_... or X-API-Key: bwk_live_...'
              param: null
              details: {}
              docsUrl: https://boardwalkai.com/docs/api/errors#missing_api_key
              requestId: req_01K1QF3M0000EXAMPLE0001
      headers:
        X-Boardwalk-Schema-Version:
          $ref: '#/components/headers/BoardwalkSchemaVersion'
    IdempotencyConflict:
      description: 'The `Idempotency-Key` on this request conflicts with an earlier one. `error.code` says which:


        * `idempotency_key_reuse`: this key was already used for a **different** request. `details.originalEndpoint` and `details.originalCreatedAt` name the request it belongs to. Mint a new key per distinct request; reuse a key only to retry the request it was minted for.

        * `idempotency_in_flight`: the original request with this key is still running. Retry in a moment to receive its result; you will not be charged twice. Carries a `Retry-After` header, echoed as `details.retryAfterSeconds`.


        Both name `Idempotency-Key` in `error.param`. Nothing is delivered and nothing is charged.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: idempotency_key_reuse
              message: This Idempotency-Key was already used for a different request. Generate a new key for each distinct request; reuse a key only to retry the request it was minted for.
              param: Idempotency-Key
              details:
                originalEndpoint: api_v1_projects_search
                originalCreatedAt: '2026-08-27T14:02:11+00:00'
              docsUrl: https://boardwalkai.com/docs/api/errors#idempotency_key_reuse
              requestId: req_01K1QF3M0000EXAMPLE0001
      headers:
        X-Boardwalk-Schema-Version:
          $ref: '#/components/headers/BoardwalkSchemaVersion'
    RateLimitExceeded:
      description: 'Too many requests in the trailing 60 seconds. Limits are per API key: 60 requests per minute on any paid plan, 10 per minute on a free-trial key. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a 429 also carries Retry-After. Before authentication, a missing credential uses a 10-per-minute source-IP bucket and an unknown or unusable Boardwalk-shaped key uses its own 10-per-minute credential-digest bucket.'
      headers:
        X-Boardwalk-Schema-Version:
          $ref: '#/components/headers/BoardwalkSchemaVersion'
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed per minute for the applicable key or pre-authentication bucket.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp at which the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: rate_limit_exceeded
              message: Rate limit of 60 requests per minute exceeded. Retry in 12 seconds.
              param: null
              details:
                retryAfterSeconds: 12
              docsUrl: https://boardwalkai.com/docs/api/errors#rate_limit_exceeded
              requestId: req_01K1QF3M0000EXAMPLE0001
  schemas:
    ApiError:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - param
          - details
          - docsUrl
          - requestId
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this value.
            message:
              type: string
              description: Human-readable explanation. Do not parse it.
            param:
              type:
              - string
              - 'null'
              description: The offending input parameter, when applicable.
            details:
              type: object
              description: Structured, camelCase context. Always an object, empty when there is no context.
              additionalProperties: true
            docsUrl:
              type: string
              format: uri
              description: Documentation for this exact error code.
            requestId:
              type: string
              description: Matches X-Request-Id and the server-side usage/log record.
          additionalProperties: false
      additionalProperties: false
    Document:
      type: object
      description: A source meeting document (council/commission meeting, agenda packet, staff report, etc.).
      properties:
        id:
          type: integer
        title:
          type:
          - string
          - 'null'
        meetingDate:
          type:
          - string
          - 'null'
          format: date
        type:
          type:
          - string
          - 'null'
        category:
          type: string
        city:
          type:
          - object
          - 'null'
          properties:
            id:
              type: integer
            name:
              type: string
            state:
              type: string
        county:
          type:
          - object
          - 'null'
          properties:
            id:
              type: integer
            name:
              type: string
            state:
              type: string
        specialDistrict:
          type:
          - object
          - 'null'
        filePath:
          type:
          - string
          - 'null'
          description: S3-relative path to the source PDF.
        fileSize:
          type:
          - integer
          - 'null'
        sourceUrl:
          type:
          - string
          - 'null'
        sourceUrlId:
          type:
          - integer
          - 'null'
        rawText:
          type:
          - string
          - 'null'
          description: Full extracted text. Can be very large.
        summary:
          type:
          - string
          - 'null'
          description: LLM-generated summary.
        analysisV2:
          type:
          - object
          - 'null'
          description: Structured analysis extracted from the document.
        officialsPresent:
          type: array
          items:
            type: string
        topics:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
        htmlContext:
          type:
          - string
          - 'null'
        extractionMethod:
          type:
          - string
          - 'null'
        contextConfidenceScore:
          type:
          - integer
          - 'null'
        processed:
          type: boolean
        processedAt:
          type:
          - string
          - 'null'
          format: date-time
        propertiesExtracted:
          type: boolean
        propertiesExtractedAt:
          type:
          - string
          - 'null'
          format: date-time
        audited:
          type: boolean
        auditedAt:
          type:
          - string
          - 'null'
          format: date-time
        imagesExtracted:
          type: boolean
        imagesExtractedAt:
          type:
          - string
          - 'null'
          format: date-time
        extractionFailed:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    DocumentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Document'
        meta:
          type: object
          properties:
            creditsUsed:
              type: integer
            creditsRemaining:
              type: integer
  headers:
    BoardwalkSchemaVersion:
      description: The date-stamped response contract version. Present on every public v1 response.
      schema:
        type: string
        example: '2026-09-16'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Boardwalk API key. Keys you create under Settings → API are prefixed `bwk_live_` and read the production corpus against your plan or free-trial balance. `bwk_test_` is reserved for a separate sandbox environment that is not serving data yet. Pre-rename `csk_` keys are accepted indefinitely. Create and rotate keys at https://boardwalkai.com/profile/api.
x-refined-from:
- boardwalkai-com-openapi.json
- boardwalkai-com-openapi.yml