Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Compute Grid API

12 actions 12 updates phrasing extends openapi/thehiveryiq-com-compute-grid-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info
$.paths['/v1/compute-grid/verify'].post
$.paths['/v1/compute-grid/capacity'].get
$.paths['/v1/compute-grid/agents'].get
$.paths['/v1/compute-grid/providers'].get
$.paths['/v1/compute-grid/quote'].post
$.paths['/v1/compute-grid/solve'].post
$.paths['/v1/compute-grid/book'].post
$.paths['/v1/compute-grid/status'].get
$.paths['/v1/compute-grid/release'].post
$.paths['/v1/compute-grid/audit'].get
$.paths['/v1/compute-grid/verify-selection'].post

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 Thehiveryiq Com Compute Grid API
  version: 1.0.0
extends: openapi/thehiveryiq-com-compute-grid-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: 11
- target: $.paths['/v1/compute-grid/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a zk-proof and get a signed receipt
      effect: write
      questions:
      - Can I verify a Groth16 zk-proof and receive a signed receipt?
      - What does verifying a proof cost per proof?
      instructions:
      - text: Verify proof {proof} with public inputs {public_inputs}.
        slots:
          proof: requestBody.proof
          public_inputs: requestBody.public_inputs
      - text: Check {proof_system} proof {proof} against inputs {public_inputs} and sign a receipt.
        slots:
          proof_system: requestBody.proof_system
          proof: requestBody.proof
          public_inputs: requestBody.public_inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/capacity'].get
  update:
    x-apievangelist-phrasing:
      intent: Check available compute grid capacity
      effect: read
      questions:
      - How much GPU and CPU capacity is currently available on the compute grid?
      - Can I force a fresh capacity reading instead of a cached one?
      instructions:
      - text: Show current compute grid capacity.
      - text: Refresh capacity with {refresh} and return the top {n} entries.
        slots:
          refresh: query.refresh
          n: query.n
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List compute grid agent types
      effect: read
      questions:
      - What operational agent types run the compute grid and how many instances exist?
      - Where is the Compute Grid agent registry?
      instructions:
      - text: List the compute grid agent registry.
      - text: Show the operational agent types and their instances.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List compute providers and their health
      effect: read
      questions:
      - Which compute provider adapters are enabled and are their upstreams healthy?
      - Are the provider health checks real probes or mocked?
      instructions:
      - text: List enabled compute providers with upstream health.
      - text: Check which compute adapters are currently healthy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/quote'].post
  update:
    x-apievangelist-phrasing:
      intent: Get compute price quotes without an auction
      effect: read
      questions:
      - What would an H100 cost across providers for a few hours without committing?
      - Can I compare compute quotes without writing anything to the ledger?
      instructions:
      - text: Quote {gpu_type} for {duration_hours} hours across providers.
        slots:
          gpu_type: requestBody.gpu_type
          duration_hours: requestBody.duration_hours
      - text: Price-check {cpu_cores} cores and {ram_gb} GB RAM within {budget_usd} USD.
        slots:
          cpu_cores: requestBody.cpu_cores
          ram_gb: requestBody.ram_gb
          budget_usd: requestBody.budget_usd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/solve'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a cross-provider compute auction
      effect: write
      questions:
      - How do I run the auction that picks a winning compute provider with a selection proof?
      - Can I run the auction in probe mode without persisting to the ledger?
      instructions:
      - text: Run the compute auction for {gpu_type} for {duration_hours} hours under {budget_usd} USD.
        slots:
          gpu_type: requestBody.gpu_type
          duration_hours: requestBody.duration_hours
          budget_usd: requestBody.budget_usd
      - text: Solve job {job_id} with persist set to {persist}.
        slots:
          job_id: requestBody.job_id
          persist: query.persist
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/book'].post
  update:
    x-apievangelist-phrasing:
      intent: Reserve compute with the auction winner
      effect: write
      questions:
      - Once an auction picks a provider, how do I actually reserve the compute?
      - What happens if the provider's reservation key is not configured?
      instructions:
      - text: Book auction {auction_id} with provider {provider} using quote {quote} before {deadline_unix}.
        slots:
          auction_id: requestBody.auction_id
          provider: requestBody.provider
          quote: requestBody.quote
          deadline_unix: requestBody.deadline_unix
      - text: Reserve the winning quote {quote} from {provider} for auction {auction_id} by {deadline_unix}.
        slots:
          quote: requestBody.quote
          provider: requestBody.provider
          auction_id: requestBody.auction_id
          deadline_unix: requestBody.deadline_unix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a compute booking's status
      effect: read
      questions:
      - What is the current state of my compute booking?
      - Can I poll a reservation by its booking id?
      instructions:
      - text: Check the status of booking {booking_id}.
        slots:
          booking_id: query.booking_id
      - text: Poll compute booking {booking_id}.
        slots:
          booking_id: query.booking_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/release'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a compute booking
      effect: destructive
      questions:
      - How do I give back compute I reserved when I'm done?
      - Can I release a booking held with a specific provider?
      instructions:
      - text: Release booking {booking_id} with provider {provider}.
        slots:
          booking_id: requestBody.booking_id
          provider: requestBody.provider
      - text: Free up the compute held under {booking_id} at {provider}.
        slots:
          booking_id: requestBody.booking_id
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: Read compute auction history
      effect: read
      questions:
      - Which compute auctions ran recently and what did they cost in USDC?
      - Where can I review the auction ledger entries?
      instructions:
      - text: Show the last {limit} compute auctions.
        slots:
          limit: query.limit
      - text: Read the compute auction audit log.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/compute-grid/verify-selection'].post
  update:
    x-apievangelist-phrasing:
      intent: Independently verify an auction selection proof
      effect: write
      questions:
      - Can I independently check the selection proof returned by an auction?
      - Is there a way to verify a solve result without building a claim myself?
      instructions:
      - text: Verify the selection proof {proof} with inputs {public_inputs} from my auction.
        slots:
          proof: requestBody.proof
          public_inputs: requestBody.public_inputs
      - text: Check the auction winner proof {proof} against {public_inputs}.
        slots:
          proof: requestBody.proof
          public_inputs: requestBody.public_inputs
      method: generated
      generated: '2026-09-26'