Inboxy Articles API

openapi: 3.2.0
info:
  title: inboxy Articles API
  version: 0.3.0
  summary: Read + manage your inboxy.net inbox programmatically.
  description: 'REST surface over the inboxy alias inbox. Mint aliases, list/search/read

    messages, fetch attachments, manage your API keys, and emit user-initiated

    mail under one of your aliases.


    Mail-emitting paths (`POST /v1/messages/{id}/reply`, `POST /v1/mail/send`,

    `POST /v1/mail/invite`) are recipient-locked and alias-locked server-side:

    the `From:` is always one of the caller''s `@inboxy.net` aliases, the

    recipient is validated against per-user caps and the abuse rules in

    `packages/reply`, and every external message carries the mandatory

    inboxy attribution footer. There is no arbitrary-`From:` send path.


    All endpoints require a bearer API key created from the inboxy.net web UI

    at `/account/keys` (mint is gated by step-up and lives only on the web — there

    is no API-channel mint). Pass it as `Authorization: Bearer ik_…`.


    The signed-token attachment download URLs (`/v1/attachments/{token}/download`,

    `/v1/messages/raw/{token}/download`) are public-by-token — they intentionally

    bypass bearer auth and are not listed here. Obtain them via the JSON

    endpoints below.'
  contact:
    name: inboxy
    url: https://inboxy.net
  license:
    name: Proprietary
servers:
- url: https://api.inboxy.net
  description: Production
security:
- bearerAuth: []
tags:
- name: Articles
  description: Read items from your feeds.
paths:
  /v1/articles:
    get:
      tags:
      - Articles
      summary: List articles across all your feeds, newest first
      parameters:
      - name: feed_id
        in: query
        schema:
          type: string
          format: uuid
      - name: unread
        in: query
        schema:
          type: boolean
      - name: since
        in: query
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 200
          default: 25
      - name: cursor
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Page of articles.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArticlesPage'
      operationId: getV1Articles
      x-operation-id-source: derived
  /v1/articles/count:
    get:
      tags:
      - Articles
      summary: Count articles across your feeds
      description: Returns `{ total, unread }` over the user's joined article set; optional `feed_id` scopes to one subscription.
      parameters:
      - name: feed_id
        in: query
        schema:
          type: string
          format: uuid
      - name: since
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Aggregate counts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResult'
      operationId: getV1ArticlesCount
      x-operation-id-source: derived
  /v1/articles/{id}:
    get:
      tags:
      - Articles
      summary: Get one article with link-rewritten HTML and plain-text excerpt
      description: Every `` in `content_html` is rewritten through the inboxy redirector (apps/link). Original publisher URLs are not returned.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Article.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArticleDetail'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getV1ArticlesById
      x-operation-id-source: derived
  /v1/articles/{id}/read:
    post:
      tags:
      - Articles
      summary: Mark an article as read
      description: Requires `manage` scope.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  read:
                    type: boolean
                    enum:
                    - true
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postV1ArticlesByIdRead
      x-operation-id-source: derived
  /v1/articles/{id}/unread:
    post:
      tags:
      - Articles
      summary: Mark an article as unread
      description: Requires `manage` scope.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  read:
                    type: boolean
                    enum:
                    - false
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postV1ArticlesByIdUnread
      x-operation-id-source: derived
  /v1/articles/read-all:
    post:
      tags:
      - Articles
      summary: Mark every unread article matching a filter as read
      description: Requires `manage` scope. Body is an optional filter — `feed_id` scopes to one subscription; `before` (ISO-8601) only marks articles published strictly before this instant. Empty body marks every unread article read. Idempotent.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkAllArticlesRequest'
      responses:
        '200':
          description: Update succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkAllResult'
        '403':
          $ref: '#/components/responses/Forbidden'
      operationId: postV1ArticlesReadAll
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - gone
          - rate_limited
          - internal
          - invalid_token
          - blocked
        message:
          type: string
    ArticleDetail:
      type: object
      required:
      - id
      - feed_source_id
      - read
      - fetched_at
      properties:
        id:
          type: string
          format: uuid
        feed_source_id:
          type: string
          format: uuid
        title:
          type:
          - string
          - 'null'
        link:
          type:
          - string
          - 'null'
          format: uri
        author:
          type:
          - string
          - 'null'
        published_at:
          type:
          - integer
          - 'null'
        fetched_at:
          type: integer
        read:
          type: boolean
        content_html:
          type:
          - string
          - 'null'
          description: Sanitised HTML with every <a href> rewritten through the inboxy redirector. Original publisher URLs are not returned.
        content_text:
          type:
          - string
          - 'null'
    ArticleMeta:
      type: object
      required:
      - id
      - feed_id
      - read
      - fetched_at
      properties:
        id:
          type: string
          format: uuid
        feed_id:
          type: string
          format: uuid
          description: The subscription id this article surfaces through.
        title:
          type:
          - string
          - 'null'
        link:
          type:
          - string
          - 'null'
          format: uri
        author:
          type:
          - string
          - 'null'
        published_at:
          type:
          - integer
          - 'null'
        fetched_at:
          type: integer
        read:
          type: boolean
    CountResult:
      type: object
      required:
      - total
      - unread
      description: Aggregate over a filtered set. `total` counts every matching row; `unread` is the subset that is still unread.
      properties:
        total:
          type: integer
          minimum: 0
        unread:
          type: integer
          minimum: 0
    MarkAllArticlesRequest:
      type: object
      description: Optional filter scoping which articles are marked. Empty object marks every unread article read.
      properties:
        feed_id:
          type: string
          format: uuid
          description: Subscription id.
        before:
          type: string
          format: date-time
          description: ISO-8601; only mark articles published strictly before this instant.
    ArticlesPage:
      type: object
      required:
      - articles
      properties:
        articles:
          type: array
          items:
            $ref: '#/components/schemas/ArticleMeta'
        next_cursor:
          type:
          - string
          - 'null'
    MarkAllResult:
      type: object
      required:
      - marked
      description: Result of a bulk mark-as-read. `marked` is the number of rows mutated by this call (already-read rows are skipped).
      properties:
        marked:
          type: integer
          minimum: 0
  responses:
    NotFound:
      description: No matching resource owned by the caller.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ik_…
      description: Static API key. Three scopes — `read` (everything except mutations), `manage` (mutations other than sending) and `send` (`/v1/mail/send`, replies, invites). Mint at https://inboxy.net/account/keys (the web UI gates mint with step-up; there is no API-channel mint).