# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 0xArchive HIP-4 Outcomes - Open Interest API
  version: 1.0.0
extends: openapi/0xarchive-hip-4-outcomes-open-interest-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/hyperliquid/hip4/openinterest/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-4 outcome side open interest history
      effect: read
      questions:
      - How has open interest on one side of a HIP-4 outcome changed?
      - Does HIP-4 open interest history include outcome_id and side?
      instructions:
      - text: Get HIP-4 open interest history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull {interval} OI for outcome side {symbol}.
        slots:
          interval: query.interval
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/openinterest/{symbol}/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current HIP-4 outcome side open interest
      effect: read
      questions:
      - What is the open interest on a HIP-4 outcome side right now?
      - Is HIP-4 current mark price a probability rather than USD?
      instructions:
      - text: Get the current HIP-4 open interest for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show latest OI for outcome side {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'