Hive Civilization

Hive Civilization Portal Spin API

The portal-spin API from Hive Civilization — 8 operation(s) for portal-spin.

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/portal/spin/start Start an anonymous demo spin session · Spin Start #
Ask an LLM
“Can I try the receipt portal without signing up?”
“Which industry verticals can I pick for a demo spin session?”
Tell an agent
Start a demo spin session for the {vertical} vertical.
Start an anonymous spin with {sample_size} sample receipts in {vertical}.
POST /v1/portal/spin/emit-receipt Add a sample receipt to a spin session · Spin Emit Receipt #
Ask an LLM
“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?”
Tell an agent
Emit another sample receipt into spin session {spin_session_id}.
Add a {event_type} sample receipt for {amount_usdc} USDC to session {spin_session_id}.
POST /v1/portal/spin/promote Promote a demo spin session into a real tenant · Spin Promote #
Ask an LLM
“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?”
Tell an agent
Promote spin session {spin_session_id} to a real tenant.
Convert session {spin_session_id} into tenant {tenant_slug} registered to {email}.
GET /v1/portal/{tenant_id}/lattice Get a tenant's receipts for the lattice view · Tenant Lattice #
Ask an LLM
“How do I get my receipts laid out for the wave-lattice visualization?”
“Which receipts in the lattice are still pending settlement?”
Tell an agent
Get the receipt lattice for tenant {tenant_id}.
Show tenant {tenant_id}'s receipts as lattice nodes with settlement status.
GET /v1/portal/{tenant_id}/ledger View a tenant's full accounting ledger · Tenant Ledger #
Ask an LLM
“Where can I see every charge and settlement with its USDC transaction hash?”
“Can I audit my account's full ledger on-chain?”
Tell an agent
Show the full ledger for tenant {tenant_id}.
List every charge and settlement for {tenant_id} with tx hashes.
POST /v1/portal/{tenant_id}/reports/pull Generate a tenant report on demand · Reports Pull #
Ask an LLM
“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?”
Tell an agent
Generate a {report_type} report for tenant {tenant_id}.
Pull a report for {tenant_id} from {date_from} to {date_to}.
POST /v1/portal/{tenant_id}/reports/schedule Schedule a recurring email report · Reports Schedule #
Ask an LLM
“How do I get a daily or weekly report emailed to me?”
“Can I choose the UTC time a scheduled report is sent?”
Tell an agent
Email a {frequency} report for tenant {tenant_id} to {email}.
Schedule a {report_type} report for {tenant_id} to {email} at {time_utc} UTC.
POST /v1/portal/{tenant_id}/reports/reminders Set a threshold alert for a tenant · Reports Reminders #
Ask an LLM
“Can I get alerted when my error rate or volume crosses a threshold?”
“What condition format do custom portal alerts use?”
Tell an agent
Alert {notify_email} when {condition} for tenant {tenant_id}.
Create a reminder labelled {label} on {tenant_id} that emails {notify_email} if {condition}.

Documentation

📖
Documentation
https://thehiveryiq.com/developers
📖
APIReference
https://receipts.thehiveryiq.com/docs
📖
GettingStarted
https://thehiveryiq.com/agents
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/authentication/thehiveryiq-com-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/rate-limits/thehiveryiq-com-rate-limits.yml
📖
Documentation
https://thehiveryiq.com/sdk-quickstart/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/openapi/thehiveryiq-com-portal-spin-api-openapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/llms/thehiveryiq-com-receipts-llms.txt
🔗
LLMsTxt
https://receipts.thehiveryiq.com/llms.txt
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/data-model/thehiveryiq-com-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/asyncapi/thehiveryiq-com-webhooks.yml
🔗
StatusPage
https://receipts.thehiveryiq.com/status
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/conventions/thehiveryiq-com-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/conventions/thehiveryiq-com-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/errors/thehiveryiq-com-problem-types.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/sandbox/thehiveryiq-com-sandbox.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/llms/thehiveryiq-com-hivecompute-llms.txt
🔗
LLMsTxt
https://api.thehiveryiq.com/llms.txt
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/mcp/thehiveryiq-com-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/thehiveryiq-com:thehiveryiq-com-portal-spin-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

thehiveryiq-com-portal-spin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HiveMorph v0.1 Portal Spin API
  description: 'Polymorphic agent runtime — single shape (Merchant), single supermodel (W2 MERCHANT). Three gates: NEED + YIELD + CLEAN-MONEY.'
  version: 0.1.0
tags:
- name: portal-spin
paths:
  /v1/portal/spin/start:
    post:
      tags:
      - portal-spin
      summary: Spin Start
      description: 'Anonymous spin session start. No signup required.

        Returns a spin_session_id, vertical config, and pre-generated sample receipts.'
      operationId: spin_start_v1_portal_spin_start_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpinStartRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpinStartResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/spin/emit-receipt:
    post:
      tags:
      - portal-spin
      summary: Spin Emit Receipt
      description: 'Emit an additional sample receipt into the spin session. Creates a new

        dual-signed (Ed25519 + ML-DSA-65) receipt envelope and appends it to the session.'
      operationId: spin_emit_receipt_v1_portal_spin_emit_receipt_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmitReceiptRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmitReceiptResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/spin/promote:
    post:
      tags:
      - portal-spin
      summary: Spin Promote
      description: 'Promote a spin session into a real tenant. Called when user clicks

        ''Show me my dashboard''. Carries over receipts and vertical.'
      operationId: spin_promote_v1_portal_spin_promote_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromoteRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromoteResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/{tenant_id}/lattice:
    get:
      tags:
      - portal-spin
      summary: Tenant Lattice
      description: 'Return receipts formatted for the wave-lattice visualization.

        Each node carries x/y/radius/color/label/hash/settlement_status.'
      operationId: tenant_lattice_v1_portal__tenant_id__lattice_get
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          title: Tenant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Tenant Lattice V1 Portal  Tenant Id  Lattice Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/{tenant_id}/ledger:
    get:
      tags:
      - portal-spin
      summary: Tenant Ledger
      description: 'Full accounting ledger. Every charge and settlement with USDC tx hashes

        clickable to Basescan. Transparent, machine-verifiable.'
      operationId: tenant_ledger_v1_portal__tenant_id__ledger_get
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          title: Tenant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Tenant Ledger V1 Portal  Tenant Id  Ledger Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/{tenant_id}/reports/pull:
    post:
      tags:
      - portal-spin
      summary: Reports Pull
      description: Generate a report on demand. Returns structured report data.
      operationId: reports_pull_v1_portal__tenant_id__reports_pull_post
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          title: Tenant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PullReportRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Reports Pull V1 Portal  Tenant Id  Reports Pull Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/{tenant_id}/reports/schedule:
    post:
      tags:
      - portal-spin
      summary: Reports Schedule
      description: Schedule a daily or weekly email report for the tenant.
      operationId: reports_schedule_v1_portal__tenant_id__reports_schedule_post
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          title: Tenant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Reports Schedule V1 Portal  Tenant Id  Reports Schedule Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portal/{tenant_id}/reports/reminders:
    post:
      tags:
      - portal-spin
      summary: Reports Reminders
      description: 'Set a custom alert/reminder. Condition format: metric>threshold e.g. volume>1000, error_rate>5.'
      operationId: reports_reminders_v1_portal__tenant_id__reports_reminders_post
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: string
          title: Tenant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReminderRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Reports Reminders V1 Portal  Tenant Id  Reports Reminders Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EmitReceiptResponse:
      properties:
        receipt:
          additionalProperties: true
          type: object
          title: Receipt
        total_receipts:
          type: integer
          title: Total Receipts
        session_id:
          type: string
          title: Session Id
      type: object
      required:
      - receipt
      - total_receipts
      - session_id
      title: EmitReceiptResponse
    SpinStartRequest:
      properties:
        vertical:
          type: string
          title: Vertical
          description: 'One of: banking, healthcare, construction, agent-payments, real-estate, ai-compliance'
          default: banking
        sample_size:
          type: integer
          maximum: 20.0
          minimum: 1.0
          title: Sample Size
          description: Number of sample receipts to pre-generate
          default: 5
      type: object
      title: SpinStartRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PullReportRequest:
      properties:
        report_type:
          type: string
          title: Report Type
          description: summary | full_ledger | compliance | usage
          default: summary
        date_from:
          anyOf:
          - type: string
          - type: 'null'
          title: Date From
        date_to:
          anyOf:
          - type: string
          - type: 'null'
          title: Date To
      type: object
      title: PullReportRequest
    SpinStartResponse:
      properties:
        spin_session_id:
          type: string
          title: Spin Session Id
        vertical:
          type: string
          title: Vertical
        vertical_config:
          additionalProperties: true
          type: object
          title: Vertical Config
        receipts:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Receipts
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - spin_session_id
      - vertical
      - vertical_config
      - receipts
      - created_at
      title: SpinStartResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PromoteRequest:
      properties:
        spin_session_id:
          type: string
          title: Spin Session Id
        tenant_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Slug
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
      type: object
      required:
      - spin_session_id
      title: PromoteRequest
    EmitReceiptRequest:
      properties:
        spin_session_id:
          type: string
          title: Spin Session Id
        event_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Event Type
        amount_usdc:
          anyOf:
          - type: number
            maximum: 10000.0
            minimum: 0.0001
          - type: 'null'
          title: Amount Usdc
      type: object
      required:
      - spin_session_id
      title: EmitReceiptRequest
    ReminderRequest:
      properties:
        condition:
          type: string
          title: Condition
          description: e.g. volume>1000, error_rate>5, settlement_pending>10
        notify_email:
          type: string
          title: Notify Email
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
      type: object
      required:
      - condition
      - notify_email
      title: ReminderRequest
    ScheduleRequest:
      properties:
        frequency:
          type: string
          title: Frequency
          description: daily | weekly
          default: daily
        email:
          type: string
          title: Email
        time_utc:
          type: string
          title: Time Utc
          description: HH:MM UTC
          default: 09:00
        report_type:
          type: string
          title: Report Type
          default: summary
      type: object
      required:
      - email
      title: ScheduleRequest
    PromoteResponse:
      properties:
        tenant_id:
          type: string
          title: Tenant Id
        vertical:
          type: string
          title: Vertical
        receipts_carried:
          type: integer
          title: Receipts Carried
        portal_url:
          type: string
          title: Portal Url
        promoted_at:
          type: string
          title: Promoted At
      type: object
      required:
      - tenant_id
      - vertical
      - receipts_carried
      - portal_url
      - promoted_at
      title: PromoteResponse
x-provenance:
  method: harvested
  publisher: Hive Civilization
  source: https://receipts.thehiveryiq.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)