openapi: 3.1.0
info:
  title: Sentinel Monitor
  version: "1.0.0"
  description: |
    Short check. Returns one sentence, a direction, a delta, and a receipt URL.
    Does not return the signal breakdown. The full analyze API is Sentinel Pro.
    No key: 3 checks a day, then a link to checkout.
    With a Monitor key in the x-api-key header: 10 checks a month.
servers:
  - url: https://blackhorsesentinel.com
paths:
  /api/v1/monitor/check:
    post:
      operationId: checkLanguage
      summary: Say whether this language hardened or softened
      description: |
        Paste a headline or a paragraph of at least 40 characters.
        seriesId federal-reserve compares with the prior Fed meeting.
        seriesId thomas-massie compares with his last stored floor speech.
        Omit seriesId to compare with the latest Federal Reserve statement.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [text]
              properties:
                text:
                  type: string
                seriesId:
                  type: string
                  enum: [federal-reserve, thomas-massie]
      responses:
        "200":
          description: One sentence and a receipt
          content:
            application/json:
              schema:
                type: object
                properties:
                  sentence:
                    type: string
                  direction:
                    type: string
                    enum: [hardened, softened, same]
                  delta:
                    type: number
                  seriesId:
                    type: string
                    nullable: true
                  receiptUrl:
                    type: string
                  upgradeUrl:
                    type: string
                  remaining:
                    type: integer
                    nullable: true
        "402":
          description: Sample or monthly quota used. Send the user to upgradeUrl.
components:
  securitySchemes:
    MonitorKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Optional. A bhs_live_ key from Sentinel Monitor. The full API rejects this key.
security:
  - MonitorKey: []
  - {}
