Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Aris Agent Asset API

7 actions 7 updates phrasing extends openapi/thehiveryiq-com-aris-agent-asset-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 7

$.info
$.paths['/v1/exchange/agent_asset/list'].post
$.paths['/v1/exchange/agent_asset/perp/open'].post
$.paths['/v1/exchange/agent_asset/perp/close'].post
$.paths['/v1/exchange/agent_asset/perp/funding/tick'].post
$.paths['/v1/exchange/agent_asset/perp/market'].get
$.paths['/v1/exchange/agent_asset/perp/position/{position_id}'].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 Thehiveryiq Com Aris Agent Asset API
  version: 1.0.0
extends: openapi/thehiveryiq-com-aris-agent-asset-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: 6
- target: $.paths['/v1/exchange/agent_asset/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a revenue-earning agent for sale
      effect: write
      questions:
      - How do I list my revenue-generating AI agent on the exchange?
      - Can I sell fractional shares of an agent and set an asking price?
      - Which source protocols can an agent asset come from?
      instructions:
      - text: List agent {agent_id} from {source_protocol} earning {monthly_revenue_usdc} USDC a month, live {days_live} days.
        slots:
          agent_id: requestBody.agent_id
          source_protocol: requestBody.source_protocol
          monthly_revenue_usdc: requestBody.monthly_revenue_usdc
          days_live: requestBody.days_live
      - text: Offer {fractional_shares} shares of agent {agent_id} ({source_protocol}, {monthly_revenue_usdc} USDC/mo, {days_live} days) at {asking_price_usdc} USDC.
        slots:
          fractional_shares: requestBody.fractional_shares
          agent_id: requestBody.agent_id
          source_protocol: requestBody.source_protocol
          monthly_revenue_usdc: requestBody.monthly_revenue_usdc
          days_live: requestBody.days_live
          asking_price_usdc: requestBody.asking_price_usdc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exchange/agent_asset/perp/open'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a perp on an agent asset
      effect: write
      questions:
      - Can I go long or short on an AI agent's revenue with a perpetual?
      - How do I open a perp position on an agent asset underlying?
      instructions:
      - text: Open a {side} perp on {underlying_key} for {size_usdc} USDC with {collateral_asset} collateral.
        slots:
          side: requestBody.side
          underlying_key: requestBody.underlying_key
          size_usdc: requestBody.size_usdc
          collateral_asset: requestBody.collateral_asset
      - text: Take a {side} position on agent asset {underlying_key} sized {size_usdc} USDC, posting {collateral_amount} {collateral_asset}.
        slots:
          underlying_key: requestBody.underlying_key
          size_usdc: requestBody.size_usdc
          collateral_amount: requestBody.collateral_amount
          collateral_asset: requestBody.collateral_asset
          side: requestBody.side
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exchange/agent_asset/perp/close'].post
  update:
    x-apievangelist-phrasing:
      intent: Close an agent-asset perp position
      effect: destructive
      questions:
      - How do I close my perp on an agent asset?
      - Can I exit an agent-asset perpetual position?
      instructions:
      - text: Close agent-asset perp {position_id}.
        slots:
          position_id: requestBody.position_id
      - text: Exit my agent perp position {position_id}.
        slots:
          position_id: requestBody.position_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exchange/agent_asset/perp/funding/tick'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply funding to an agent-asset perp market
      effect: write
      questions:
      - How is funding applied to perps on a single agent asset?
      - Can an operator run a funding tick for one agent underlying?
      instructions:
      - text: Run a funding tick for agent asset {underlying_key}.
        slots:
          underlying_key: requestBody.underlying_key
      - text: Apply funding on {underlying_key} using admin key {X-Admin-Api-Key}.
        slots:
          underlying_key: requestBody.underlying_key
          X-Admin-Api-Key: header.X-Admin-Api-Key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exchange/agent_asset/perp/market'].get
  update:
    x-apievangelist-phrasing:
      intent: View the perp market for an agent asset
      effect: read
      questions:
      - What does the perp market look like for a specific agent asset?
      - Where can I see open interest and funding for an agent underlying?
      instructions:
      - text: Show the perp market for {underlying_key}.
        slots:
          underlying_key: query.underlying_key
      - text: Get market state for agent asset {underlying_key}.
        slots:
          underlying_key: query.underlying_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exchange/agent_asset/perp/position/{position_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent-asset perp position
      effect: read
      questions:
      - How do I check one of my agent-asset perp positions?
      - What is the current state of a specific agent perp?
      instructions:
      - text: Get agent-asset perp position {position_id}.
        slots:
          position_id: path.position_id
      - text: Show details of my agent perp {position_id}.
        slots:
          position_id: path.position_id
      method: generated
      generated: '2026-09-26'