# 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 - Convenience API
  version: 1.0.0
extends: openapi/0xarchive-hip-4-outcomes-convenience-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: 3
- target: $.paths['/v1/hyperliquid/hip4/freshness/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check how fresh a HIP-4 outcome side's data is
      effect: read
      questions:
      - When was order book and trade data last updated for a HIP-4 side?
      - Why are funding and liquidation buckets missing from HIP-4 freshness?
      instructions:
      - text: Check HIP-4 data freshness for {symbol}.
        slots:
          symbol: path.symbol
      - text: Show when outcome side {symbol} data last updated.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/summary/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-call HIP-4 outcome side summary
      effect: read
      questions:
      - What is the implied probability and 24h volume for a HIP-4 outcome?
      - Can I get mark, mid and open interest for an outcome side in one call?
      instructions:
      - text: Get the HIP-4 market summary for {symbol}.
        slots:
          symbol: path.symbol
      - text: Give me the current implied probability and volume for {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/prices/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIP-4 outcome side price history
      effect: read
      questions:
      - How has an outcome's implied probability moved over time?
      - Can I get only mark and mid prices for a HIP-4 side?
      instructions:
      - text: Get HIP-4 price history for {symbol} from {start} to {end}.
        slots:
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Show {interval} implied probability history for {symbol}.
        slots:
          interval: query.interval
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'