Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Trade Finance API

7 actions 7 updates phrasing extends openapi/thehiveryiq-com-trade-finance-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/trade/invoice'].post
$.paths['/v1/trade/invoice/{invoice_id}'].get
$.paths['/v1/trade/invoice/{invoice_id}/dispute'].post
$.paths['/v1/trade/fees'].get
$.paths['/v1/trade/listing'].get
$.paths['/v1/trade/invoices'].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 Trade Finance API
  version: 1.0.0
extends: openapi/thehiveryiq-com-trade-finance-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/trade/invoice'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cross-border SMB trade invoice
      effect: write
      questions:
      - How do I invoice a cross-border supplier payment in USDT with a platform fee shown up front?
      - Which Incoterms and settlement chains can a trade invoice use?
      - Can I settle a trade invoice in USDC instead of USDT?
      instructions:
      - text: Create an invoice for {amount_usdt} USDT from buyer {buyer_address} to supplier {supplier_address} in {supplier_country}, PO {purchase_order_ref}.
        slots:
          amount_usdt: requestBody.amount_usdt
          buyer_address: requestBody.buyer_address
          supplier_address: requestBody.supplier_address
          supplier_country: requestBody.supplier_country
          purchase_order_ref: requestBody.purchase_order_ref
      - text: Invoice {amount_usdt} for {currency_pair} under {incoterm}, settling on {expected_settlement_chain}.
        slots:
          amount_usdt: requestBody.amount_usdt
          currency_pair: requestBody.currency_pair
          incoterm: requestBody.incoterm
          expected_settlement_chain: requestBody.expected_settlement_chain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trade/invoice/{invoice_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trade invoice and its route
      effect: read
      questions:
      - What is the status and payment route of a specific trade invoice?
      - Can I look up one invoice's payable address?
      instructions:
      - text: Get trade invoice {invoice_id}.
        slots:
          invoice_id: path.invoice_id
      - text: Show the settlement route for invoice {invoice_id}.
        slots:
          invoice_id: path.invoice_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trade/invoice/{invoice_id}/dispute'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a dispute on a trade invoice
      effect: write
      questions:
      - Can I dispute a trade invoice if the goods or freight went wrong?
      - Is a dispute routed to arbitration or just recorded on the invoice?
      instructions:
      - text: Dispute invoice {invoice_id} because {reason}.
        slots:
          invoice_id: path.invoice_id
          reason: requestBody.reason
      - text: Open a dispute on {invoice_id} for {reason} with evidence at {evidence_uri}.
        slots:
          invoice_id: path.invoice_id
          reason: requestBody.reason
          evidence_uri: requestBody.evidence_uri
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trade/fees'].get
  update:
    x-apievangelist-phrasing:
      intent: View the trade finance fee schedule
      effect: read
      questions:
      - What fees apply to cross-border trade invoices compared with a wire?
      - Where is the public trade fee schedule?
      instructions:
      - text: Show the trade finance fee schedule.
      - text: Get the platform fees for cross-border invoices.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trade/listing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the trade finance agent listing
      effect: read
      questions:
      - What does the trade finance service's agent marketplace listing say?
      - Can I fetch the HiveAgent listing record for trade finance?
      instructions:
      - text: Get the trade finance agent listing.
      - text: Show the HiveAgent listing for cross-border invoicing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/trade/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List all trade invoices
      effect: read
      questions:
      - Which trade invoices are in the registry?
      - Can operations see every invoice at once?
      instructions:
      - text: List all trade invoices.
      - text: Show every invoice in the trade registry.
      method: generated
      generated: '2026-09-26'