Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Portal Spin API

9 actions 9 updates phrasing extends openapi/thehiveryiq-com-portal-spin-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 9

$.info
$.paths['/v1/portal/spin/start'].post
$.paths['/v1/portal/spin/emit-receipt'].post
$.paths['/v1/portal/spin/promote'].post
$.paths['/v1/portal/{tenant_id}/lattice'].get
$.paths['/v1/portal/{tenant_id}/ledger'].get
$.paths['/v1/portal/{tenant_id}/reports/pull'].post
$.paths['/v1/portal/{tenant_id}/reports/schedule'].post
$.paths['/v1/portal/{tenant_id}/reports/reminders'].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 Portal Spin API
  version: 1.0.0
extends: openapi/thehiveryiq-com-portal-spin-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/portal/spin/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an anonymous demo spin session
      effect: write
      questions:
      - Can I try the receipt portal without signing up?
      - Which industry verticals can I pick for a demo spin session?
      instructions:
      - text: Start a demo spin session for the {vertical} vertical.
        slots:
          vertical: requestBody.vertical
      - text: Start an anonymous spin with {sample_size} sample receipts in {vertical}.
        slots:
          sample_size: requestBody.sample_size
          vertical: requestBody.vertical
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/spin/emit-receipt'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sample receipt to a spin session
      effect: write
      questions:
      - How do I generate another dual-signed sample receipt in my demo session?
      - Can I set the event type and USDC amount on a sample receipt?
      instructions:
      - text: Emit another sample receipt into spin session {spin_session_id}.
        slots:
          spin_session_id: requestBody.spin_session_id
      - text: Add a {event_type} sample receipt for {amount_usdc} USDC to session {spin_session_id}.
        slots:
          event_type: requestBody.event_type
          amount_usdc: requestBody.amount_usdc
          spin_session_id: requestBody.spin_session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/spin/promote'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a demo spin session into a real tenant
      effect: write
      questions:
      - How do I turn my demo spin session into a real dashboard account?
      - Do my sample receipts carry over when I promote a spin session?
      instructions:
      - text: Promote spin session {spin_session_id} to a real tenant.
        slots:
          spin_session_id: requestBody.spin_session_id
      - text: Convert session {spin_session_id} into tenant {tenant_slug} registered to {email}.
        slots:
          spin_session_id: requestBody.spin_session_id
          tenant_slug: requestBody.tenant_slug
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/lattice'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's receipts for the lattice view
      effect: read
      questions:
      - How do I get my receipts laid out for the wave-lattice visualization?
      - Which receipts in the lattice are still pending settlement?
      instructions:
      - text: Get the receipt lattice for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show tenant {tenant_id}'s receipts as lattice nodes with settlement status.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/ledger'].get
  update:
    x-apievangelist-phrasing:
      intent: View a tenant's full accounting ledger
      effect: read
      questions:
      - Where can I see every charge and settlement with its USDC transaction hash?
      - Can I audit my account's full ledger on-chain?
      instructions:
      - text: Show the full ledger for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: List every charge and settlement for {tenant_id} with tx hashes.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/reports/pull'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a tenant report on demand
      effect: read
      questions:
      - Can I pull a compliance or usage report for a date range right now?
      - What report types can I generate on demand for my tenant?
      instructions:
      - text: Generate a {report_type} report for tenant {tenant_id}.
        slots:
          report_type: requestBody.report_type
          tenant_id: path.tenant_id
      - text: Pull a report for {tenant_id} from {date_from} to {date_to}.
        slots:
          tenant_id: path.tenant_id
          date_from: requestBody.date_from
          date_to: requestBody.date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/reports/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a recurring email report
      effect: write
      questions:
      - How do I get a daily or weekly report emailed to me?
      - Can I choose the UTC time a scheduled report is sent?
      instructions:
      - text: Email a {frequency} report for tenant {tenant_id} to {email}.
        slots:
          frequency: requestBody.frequency
          tenant_id: path.tenant_id
          email: requestBody.email
      - text: Schedule a {report_type} report for {tenant_id} to {email} at {time_utc} UTC.
        slots:
          report_type: requestBody.report_type
          tenant_id: path.tenant_id
          email: requestBody.email
          time_utc: requestBody.time_utc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/portal/{tenant_id}/reports/reminders'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a threshold alert for a tenant
      effect: write
      questions:
      - Can I get alerted when my error rate or volume crosses a threshold?
      - What condition format do custom portal alerts use?
      instructions:
      - text: Alert {notify_email} when {condition} for tenant {tenant_id}.
        slots:
          notify_email: requestBody.notify_email
          condition: requestBody.condition
          tenant_id: path.tenant_id
      - text: Create a reminder labelled {label} on {tenant_id} that emails {notify_email} if {condition}.
        slots:
          label: requestBody.label
          tenant_id: path.tenant_id
          notify_email: requestBody.notify_email
          condition: requestBody.condition
      method: generated
      generated: '2026-09-26'