Ben Milne Categories API

openapi: 3.2.0
info:
  title: benmilne.com Developer Categories API
  description: Public read-only multilingual API for benmilne.com content. Supports 14 languages via ?lang= query parameter. English is the default and source of truth. SSE streaming available for real-time search.
  version: 2.0.0
  contact:
    name: Ben Milne
    url: https://benmilne.com/api
  x-cli:
    name: benmilne-api
    install: npm install -g benmilne-api
    registry: https://www.npmjs.com/package/benmilne-api
  x-source:
    url: https://github.com/benmilne-com/agents
    type: github
  x-ratelimit:
    strategy: edge-cache
    description: Cloudflare edge caching serves most reads. No application-level rate limit enforced. Headers included on every JSON response.
    headers:
    - X-RateLimit-Limit
    - X-RateLimit-Remaining
    - X-RateLimit-Reset
  x-graphql:
    endpoint: https://benmilne.com/graphql
    introspection: true
    description: Read-only GraphQL API with Relay cursor pagination, typed errors, and full schema descriptions. POST queries to /graphql.
servers:
- url: https://benmilne.com
  description: Production
- url: https://benmilne.com/sandbox
  description: Sandbox (canned test data)
security:
- public: []
tags:
- name: Categories
paths:
  /api/categories:
    get:
      operationId: listCategories
      summary: All categories with post counts
      parameters:
      - name: lang
        in: query
        description: Language code for translated response
        schema:
          type: string
          enum:
          - en
          - es
          - zh
          - ar
          - pt-br
          - fr
          - ja
          - de
          - ru
          - id
          - hi
          - ko
          - tr
          - vi
          default: en
      responses:
        '200':
          description: Category list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxonomyListResponse'
      tags:
      - Categories
  /api/categories/{slug}:
    get:
      operationId: listPostsByCategory
      summary: Posts filtered by category
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
          default: 1
      - name: per_page
        in: query
        schema:
          type: integer
          default: 10
      - name: lang
        in: query
        description: Language code for translated response
        schema:
          type: string
          enum:
          - en
          - es
          - zh
          - ar
          - pt-br
          - fr
          - ja
          - de
          - ru
          - id
          - hi
          - ko
          - tr
          - vi
          default: en
      - name: fallback
        in: query
        description: Set to 'en' to receive English content when translation is unavailable
        schema:
          type: string
          enum:
          - en
      responses:
        '200':
          description: Category-filtered posts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPostsResponse'
        '404':
          description: Category not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Categories
webhooks:
  stream-event:
    post:
      summary: SSE stream event delivery
      description: Events delivered via Server-Sent Events streams (/api/stream/search, /ask). Each event data payload includes an HMAC-SHA256 signature for integrity verification.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: Event type (status, result, done, error)
                data:
                  type: object
                  description: Event payload
                signature:
                  type: string
                  description: 'HMAC-SHA256 signature: sha256=<hex>'
      responses:
        '200':
          description: Event acknowledged
      security:
      - webhookSignature: []
      tags:
      - Categories
components:
  schemas:
    PaginatedPostsResponse:
      type: object
      properties:
        attribution:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/PostSummary'
        pagination:
          type: object
          properties:
            page:
              type: integer
            per_page:
              type: integer
            total:
              type: integer
            total_pages:
              type: integer
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
      - attribution
      - data
    TaxonomyListResponse:
      type: object
      properties:
        attribution:
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              slug:
                type: string
              name:
                type: string
              count:
                type: integer
    ResponseMeta:
      type: object
      properties:
        language:
          type: string
        source_language:
          type: string
        is_translation:
          type: boolean
        automated_translation:
          type: boolean
        disclaimer:
          type: string
        available_languages:
          type: array
          items:
            type: string
      required:
      - language
      - source_language
      - is_translation
      - available_languages
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        supported_languages:
          type: array
          items:
            type: string
      required:
      - error
    PostSummary:
      type: object
      properties:
        slug:
          type: string
        title:
          type: string
        date:
          type: string
        modified:
          type: string
        author:
          type: string
        summary:
          type: string
        url:
          type: string
        language:
          type: string
        is_translation:
          type: boolean
        english_url:
          type: string
        translation:
          $ref: '#/components/schemas/TranslationMeta'
      required:
      - slug
      - title
      - date
      - author
      - url
      - language
    TranslationMeta:
      type: object
      properties:
        automated:
          type: boolean
        provider:
          type:
          - string
          - 'null'
        source_language:
          type: string
        target_language:
          type: string
        verified:
          type: boolean
        stale:
          type: boolean
        fallback_used:
          type: boolean
  securitySchemes:
    public:
      type: http
      scheme: bearer
      description: All read endpoints are public and unauthenticated. No API key or token is required.
externalDocs:
  description: benmilne.com developer portal
  url: https://benmilne.com/developers