# 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 Swarm Receipts API
  version: 1.0.0
extends: openapi/thehiveryiq-com-swarm-receipts-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: 8
- target: $.paths['/v1/receipt/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a signed receipt envelope
      effect: read
      questions:
      - How do I check that a post-quantum signed receipt envelope is valid?
      - Can I verify a receipt someone handed me without logging in?
      instructions:
      - text: Verify receipt envelope {envelope}.
        slots:
          envelope: requestBody.envelope
      - text: 'Check the signatures on this receipt envelope: {envelope}.'
        slots:
          envelope: requestBody.envelope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check receipt service health
      effect: read
      questions:
      - Is the receipt issuing service up right now?
      - Can I health-check the receipt endpoints?
      instructions:
      - text: Check receipt service health.
      - text: Ping the /v1/receipt service.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/free'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign any text as a free PQ receipt
      effect: write
      questions:
      - Can I get a free post-quantum signed receipt for a PR diff or log line without an account?
      - What's the daily limit on free receipts per IP?
      instructions:
      - text: Sign {payload} as a free receipt.
        slots:
          payload: requestBody.payload
      - text: Issue a free signed receipt for {payload} labelled {label}.
        slots:
          payload: requestBody.payload
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/pq-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether the ML-DSA-65 signer is live
      effect: read
      questions:
      - Is the ML-DSA-65 post-quantum signer actually running on this host?
      - Are receipts being signed with real PQ keys right now?
      instructions:
      - text: Tell me whether the ML-DSA-65 signer is live.
      - text: Check the post-quantum signing status for receipts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get receipt pricing
      effect: read
      questions:
      - What does it cost to issue receipts beyond the free tier?
      - Where is the price list for swarm receipts?
      instructions:
      - text: Show receipt pricing.
      - text: Get the price list for issuing receipts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a swarm receipt between two agents
      effect: write
      questions:
      - How do I issue a swarm-profile receipt for a transaction between two agent DIDs?
      - Can I attach a federation round ID to a swarm receipt?
      instructions:
      - text: Issue a swarm receipt for tx {tx_hash} from {agent_did} to {counterparty_did}.
        slots:
          tx_hash: requestBody.tx_hash
          agent_did: requestBody.agent_did
          counterparty_did: requestBody.counterparty_did
      - text: Record transaction {tx_hash} between {agent_did} and {counterparty_did} in round {round_id}.
        slots:
          tx_hash: requestBody.tx_hash
          agent_did: requestBody.agent_did
          counterparty_did: requestBody.counterparty_did
          round_id: requestBody.round_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a receipt by ID
      effect: read
      questions:
      - How do I fetch a receipt I issued earlier by its ID?
      - Has a given receipt been settled yet?
      instructions:
      - text: Show receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Look up the settlement state of receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/settle'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a receipt settled on-chain
      effect: write
      questions:
      - How do I attach a settlement transaction to an issued receipt?
      - What do I need to mark a swarm receipt as settled?
      instructions:
      - text: Settle receipt {receipt_id} with transaction {settlement_tx_hash}.
        slots:
          receipt_id: requestBody.receipt_id
          settlement_tx_hash: requestBody.settlement_tx_hash
      - text: Mark {receipt_id} as settled by tx {settlement_tx_hash}.
        slots:
          receipt_id: requestBody.receipt_id
          settlement_tx_hash: requestBody.settlement_tx_hash
      method: generated
      generated: '2026-09-26'