Codex Reset Forecast API

openapi: 3.2.0
info:
  title: Codex Reset Com Forecast API
  version: 1.0.0
  contact:
    name: codex-reset.com
    url: https://codex-reset.com/developers
  license:
    name: 'Data: CC BY 4.0 with credit to codex-reset.com'
    url: https://creativecommons.org/licenses/by/4.0/
  termsOfService: https://codex-reset.com/terms
  description: 'Operations tagged Forecast across 2 of this provider''s published API definitions: codex-reset-com-openapi.json, codex-reset-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://codex-reset.com
security: []
tags:
- name: Forecast
paths:
  /api/forecast:
    get:
      operationId: getForecast
      summary: Reset forecast and the canonical Alert
      description: Chance of a Codex usage-limit reset in the next 24 and 48 hours, confidence, the last reset, the active Watch (official_signal) and latest_alert.
      parameters:
      - $ref: '#/components/parameters/locale'
      - name: tz
        in: query
        schema:
          type: string
        description: IANA time zone for display copy. Default UTC.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forecast'
        '400':
          $ref: '#/components/responses/UnsupportedLocale'
      tags:
      - Forecast
    servers:
    - url: https://codex-reset.com
components:
  parameters:
    locale:
      name: locale
      in: query
      schema:
        type: string
        enum:
        - zh
        - ja
        - es
      description: Adds translated copy (localized_summary, localized_text). Omit for English.
  schemas:
    Probabilities:
      type: object
      required:
      - rounded_24h
      - rounded_48h
      properties:
        rounded_24h:
          type: integer
          minimum: 0
          maximum: 100
          description: Chance (%) of a reset in the next 24 hours.
        rounded_48h:
          type: integer
          minimum: 0
          maximum: 100
          description: Chance (%) of a reset in the next 48 hours.
        raw_24h:
          type: number
        raw_48h:
          type: number
        range_24h:
          type: object
          description: Wilson sampling band; informational.
        range_48h:
          type: object
          description: Wilson sampling band; informational.
    AlertWindow:
      type: object
      required:
      - label
      - start_at
      - end_at
      - time_zone
      properties:
        label:
          type: string
        start_at:
          type: string
          format: date-time
        end_at:
          type: string
          format: date-time
        time_zone:
          type: string
          description: IANA time zone of Tibo's words.
        target_kind:
          type: string
        target_at:
          type: string
          format: date-time
    LatestAlert:
      type: object
      description: 'The canonical Alert: the latest ⚠️ Watch or ✅ Reset. Retained until a newer Alert replaces it.'
      required:
      - id
      - kind
      - state
      - source_at
      - summary
      - score
      - window
      - corrected
      properties:
        id:
          type: string
        kind:
          type: string
          enum:
          - watch
          - reset
        state:
          type: string
          enum:
          - active
          - expired
          - confirmed
          description: A Watch is active or expired; a Reset is confirmed.
        source_at:
          type: string
          format: date-time
        summary:
          type: string
        url:
          anyOf:
          - type: string
            format: uri
          - type: 'null'
        score:
          anyOf:
          - type: integer
            enum:
            - 83
            - 93
          - type: 'null'
        window:
          anyOf:
          - $ref: '#/components/schemas/AlertWindow'
          - type: 'null'
        pending:
          type: string
          enum:
          - done
          - on_its_way
          description: ⌛️ A Watch rung by Tibo's own completion statement before the site's monitor measured the reset; score and window are then null.
        corrected:
          type: boolean
        confirmation_source:
          type: string
        observed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
        observation_message:
          type: string
        confirmed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
        confirmation_url:
          anyOf:
          - type: string
            format: uri
          - type: 'null'
        localized_summary:
          type: string
          description: Locale responses only.
        translation_status:
          type: string
          description: Locale responses only.
    Forecast:
      type: object
      required:
      - updated_at
      - probabilities
      - confidence
      - last_reset_at
      - official_signal
      - latest_alert
      properties:
        updated_at:
          type: string
          format: date-time
        probabilities:
          $ref: '#/components/schemas/Probabilities'
        confidence:
          type: string
        last_reset_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
        official_signal:
          anyOf:
          - type: object
            description: The currently active Watch only; null once its window closes, a later Reset lands, or a banked reset answers it.
          - type: 'null'
        context:
          type: object
          description: 'Tibo context of the last seven days (QUIET / TEASE / UNCLEAR). Informational only: never changes the probabilities.'
        wait_comparison:
          anyOf:
          - type: object
            description: The current wait against the latest eight completed reset intervals.
          - type: 'null'
        model:
          type: object
        backtest:
          type: object
        latest_alert:
          anyOf:
          - $ref: '#/components/schemas/LatestAlert'
          - type: 'null'
  responses:
    UnsupportedLocale:
      description: The locale is not one of zh, ja, es.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                const: unsupported_locale
externalDocs:
  description: Developer guide
  url: https://codex-reset.com/developers
x-refined-from:
- codex-reset-com-openapi.json
- codex-reset-com-openapi.yml