BITHOT Stories API

openapi: 3.2.0
info:
  title: BITHOT Public Stories API
  version: 5.0.0
  description: 'Anonymous, read-only API for clients and Agents. No API key is required.


    Picking an endpoint: answer a person''s question inside an AI agent -> read /api/v1/agent, which lists Markdown addresses made for agents. Show recent or today''s items -> /api/v1/items. Show what is trending right now -> /api/v1/hot-topics. Show the daily digest -> /api/v1/dailies/latest; the weekly and monthly reports -> /api/v1/weeklies/latest and /api/v1/monthlies/latest. Keep a complete local copy of the selected set -> /api/v1/selected/snapshot once, then /api/v1/selected/changes forever.


    How often to poll: use each response''s Cache-Control s-maxage as the minimum interval, and always send If-None-Match: an unchanged resource answers 304 with an empty body. On 429 or 503, honour Retry-After. There is no push channel (no SSE, webhooks or streaming): poll on an interval.


    Keep responses small: send Accept-Encoding: gzip or br (curl --compressed). To follow new items, page back only until you reach an id you already have instead of re-reading the whole 7-day window on every poll; to keep every selected item, read /api/v1/selected/snapshot once and then only /api/v1/selected/changes.


    Report dates, weeks and months identify fixed editions, but corrections and withdrawn citations can change their public content. Revalidate retained copies with If-None-Match after Cache-Control expires; do not treat a dated report as immutable.


    Titles and summaries are generated from third-party sources; the original is always linked in links.original.'
  termsOfService: https://bithot.news/terms
servers:
- url: https://bithot.news
tags:
- name: Stories
paths:
  /api/v1/stories/{publicId}:
    get:
      operationId: storyByPublicId
      summary: Get a story (event) with its coverage timeline and AI digest
      description: 'One story = one real-world event aggregated from every covering source: a reverse-chronological coverage timeline, an AI digest that is rewritten incrementally as the event evolves (contradictions with earlier reporting are stated explicitly), and links to same-storyline and related stories. Extract ids from the final path segment of a hot-topics links.story HTML URL, or use ids from another story''s storyline/related refs; never request links.story as JSON. Merged stories answer with a 308 to the surviving id. Call this endpoint only with an id actually returned by the API; a 404 means the public story layer or that story is unavailable.'
      parameters:
      - $ref: '#/components/parameters/ActorUserAgent'
      - $ref: '#/components/parameters/IfNoneMatch'
      - name: publicId
        in: path
        required: true
        schema:
          type: string
          maxLength: 128
      responses:
        '200':
          description: OK
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoryResponse'
        '304':
          description: Not Modified
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
        '308':
          description: Story was merged into another; follow Location to the surviving story id.
        '400':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '405':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Machine-readable problem response.
          headers:
            X-Request-Id:
              description: Support correlation identifier for this failed request.
              schema:
                type: string
            Retry-After:
              description: Minimum number of seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      tags:
      - Stories
components:
  schemas:
    StoryReport:
      type: object
      required:
      - id
      - title
      - summary
      - source
      - publishedAt
      - links
      properties:
        id:
          type: string
        title:
          type: string
        summary:
          type:
          - string
          - 'null'
        source:
          type: object
          required:
          - name
          - firstParty
          properties:
            name:
              type: string
            firstParty:
              type: boolean
        publishedAt:
          type: string
          format: date-time
          description: When the original was published; if the original carries no reliable publication date, when it was collected instead.
        links:
          type: object
          required:
          - aihot
          properties:
            aihot:
              type: string
              format: uri
            original:
              type: string
              format: uri
    StoryNeighbor:
      type: object
      required:
      - publicId
      - title
      - relation
      - links
      properties:
        publicId:
          type: string
        title:
          type: string
        relation:
          type: string
        links:
          type: object
          required:
          - aihot
          - api
          properties:
            aihot:
              type: string
              format: uri
            api:
              type: string
              format: uri
    Story:
      type: object
      required:
      - publicId
      - title
      - status
      - sourceCount
      - reportCount
      - firstReportAt
      - latestAt
      - latest
      - digest
      - digestUpdatedAt
      - links
      - reports
      - storyline
      - related
      properties:
        publicId:
          type: string
        title:
          type: string
        status:
          enum:
          - active
          - settled
        sourceCount:
          type: integer
          minimum: 0
        reportCount:
          type: integer
          minimum: 0
        firstReportAt:
          type: string
          format: date-time
        latestAt:
          type: string
          format: date-time
        latest:
          type: string
        digest:
          type:
          - string
          - 'null'
        digestUpdatedAt:
          type:
          - string
          - 'null'
          format: date-time
        links:
          type: object
          required:
          - aihot
          properties:
            aihot:
              type: string
              format: uri
        reports:
          type: array
          items:
            $ref: '#/components/schemas/StoryReport'
        storyline:
          type: array
          items:
            $ref: '#/components/schemas/StoryNeighbor'
        related:
          type: array
          items:
            $ref: '#/components/schemas/StoryNeighbor'
    Problem:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - code
      - requestId
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        requestId:
          type: string
    StoryResponse:
      type: object
      required:
      - schemaVersion
      - story
      properties:
        schemaVersion:
          const: 1
        story:
          $ref: '#/components/schemas/Story'
  parameters:
    IfNoneMatch:
      name: If-None-Match
      in: header
      required: false
      description: Previously received ETag for this exact URL. A match returns 304 without a response body.
      schema:
        type: string
    ActorUserAgent:
      name: User-Agent
      in: header
      required: false
      description: The client's normal User-Agent (optional; any value works).
      schema:
        type: string
        maxLength: 2048
      example: my-reader/1.0
externalDocs:
  description: Machine-readable OpenAPI document
  url: https://bithot.news/openapi-v1.json