0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive HIP-4 Outcomes - Outcomes API

4 actions 4 updates phrasing extends openapi/0xarchive-hip-4-outcomes-outcomes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for 0xArchive's API. It is a proposal applied on top of the contract, not a document 0xArchive publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/hyperliquid/hip4/outcomes'].get
$.paths['/v1/hyperliquid/hip4/outcomes/{outcome_id}'].get
$.paths['/v1/hyperliquid/hip4/outcomes/by-slug/{slug}'].get

OpenAPI Overlay

Raw ↑ 
# 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 - Outcomes API
  version: 1.0.0
extends: openapi/0xarchive-hip-4-outcomes-outcomes-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/outcomes'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP-4 outcome markets
      effect: read
      questions:
      - Which HIP-4 prediction outcomes are live or settled?
      - Can I list only settled HIP-4 outcomes?
      instructions:
      - text: List all HIP-4 outcomes.
      - text: List HIP-4 outcomes where settled is {is_settled}.
        slots:
          is_settled: query.is_settled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/outcomes/{outcome_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one HIP-4 outcome with aggregated open interest
      effect: read
      questions:
      - What is the combined open interest across both sides of an outcome?
      - Can I check whether an outcome's Yes and No supply are at parity?
      instructions:
      - text: Get HIP-4 outcome {outcome_id}.
        slots:
          outcome_id: path.outcome_id
      - text: Show aggregated OI and side parity for outcome {outcome_id}.
        slots:
          outcome_id: path.outcome_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/outcomes/by-slug/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a HIP-4 outcome by slug
      effect: read
      questions:
      - Can I find a HIP-4 outcome from a readable slug like btc-above-78213-may-04-0600?
      - Does outcome lookup accept a Yes or No side slug?
      instructions:
      - text: Find the HIP-4 outcome with slug {slug}.
        slots:
          slug: path.slug
      - text: Look up outcome {slug} by its side slug.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'