Hive Civilization Swarm Receipts API

The swarm-receipts API from Hive Civilization — 8 operation(s) for swarm-receipts.

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/receipt/verify Verify a signed receipt envelope · Verify Receipt Route #
Ask an LLM
“How do I check that a post-quantum signed receipt envelope is valid?”
“Can I verify a receipt someone handed me without logging in?”
Tell an agent
Verify receipt envelope {envelope}.
Check the signatures on this receipt envelope: {envelope}.
GET /v1/receipt/health Check receipt service health · Health #
Ask an LLM
“Is the receipt issuing service up right now?”
“Can I health-check the receipt endpoints?”
Tell an agent
Check receipt service health.
Ping the /v1/receipt service.
POST /v1/receipt/free Sign any text as a free PQ receipt · Issue Free Receipt #
Ask an LLM
“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?”
Tell an agent
Sign {payload} as a free receipt.
Issue a free signed receipt for {payload} labelled {label}.
GET /v1/receipt/pq-status Check whether the ML-DSA-65 signer is live · Pq Status #
Ask an LLM
“Is the ML-DSA-65 post-quantum signer actually running on this host?”
“Are receipts being signed with real PQ keys right now?”
Tell an agent
Tell me whether the ML-DSA-65 signer is live.
Check the post-quantum signing status for receipts.
GET /v1/receipt/pricing Get receipt pricing · Pricing #
Ask an LLM
“What does it cost to issue receipts beyond the free tier?”
“Where is the price list for swarm receipts?”
Tell an agent
Show receipt pricing.
Get the price list for issuing receipts.
POST /v1/receipt/issue Issue a swarm receipt between two agents · Issue Receipt #
Ask an LLM
“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?”
Tell an agent
Issue a swarm receipt for tx {tx_hash} from {agent_did} to {counterparty_did}.
Record transaction {tx_hash} between {agent_did} and {counterparty_did} in round {round_id}.
GET /v1/receipt/{receipt_id} Get a receipt by ID · Get Receipt #
Ask an LLM
“How do I fetch a receipt I issued earlier by its ID?”
“Has a given receipt been settled yet?”
Tell an agent
Show receipt {receipt_id}.
Look up the settlement state of receipt {receipt_id}.
POST /v1/receipt/settle Mark a receipt settled on-chain · Settle Receipt #
Ask an LLM
“How do I attach a settlement transaction to an issued receipt?”
“What do I need to mark a swarm receipt as settled?”
Tell an agent
Settle receipt {receipt_id} with transaction {settlement_tx_hash}.
Mark {receipt_id} as settled by tx {settlement_tx_hash}.

Documentation

Specifications

Other Resources

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-swarm-receipts-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.

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

OpenAPI Specification

thehiveryiq-com-swarm-receipts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: HiveMorph v0.1 Swarm Receipts API
  description: 'Polymorphic agent runtime — single shape (Merchant), single supermodel (W2 MERCHANT). Three gates: NEED + YIELD + CLEAN-MONEY.'
  version: 0.1.0
tags:
- name: swarm-receipts
paths:
  /v1/receipt/verify:
    post:
      tags:
      - swarm-receipts
      summary: Verify Receipt Route
      operationId: verify_receipt_route_v1_receipt_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyRequestBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Verify Receipt Route V1 Receipt Verify Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/receipt/health:
    get:
      tags:
      - swarm-receipts
      summary: Health
      operationId: health_v1_receipt_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Health V1 Receipt Health Get
  /v1/receipt/free:
    post:
      tags:
      - swarm-receipts
      summary: Issue Free Receipt
      description: 'Free PQ-signed receipt. Rate-limited to 100/IP/day.


        No login required. Accepts any string payload (PR diff, contract clause,

        API log line, tx hash). Returns the signed envelope, a signatures block

        that states exactly what signed it, and a verify URL. After 100/day the IP

        must sign up.'
      operationId: issue_free_receipt_v1_receipt_free_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FreeIssueRequestBody'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Issue Free Receipt V1 Receipt Free Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/receipt/pq-status:
    get:
      tags:
      - swarm-receipts
      summary: Pq Status
      description: Say plainly whether the ML-DSA-65 signer is live on this host.
      operationId: pq_status_v1_receipt_pq_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Pq Status V1 Receipt Pq Status Get
  /v1/receipt/pricing:
    get:
      tags:
      - swarm-receipts
      summary: Pricing
      operationId: pricing_v1_receipt_pricing_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Pricing V1 Receipt Pricing Get
  /v1/receipt/issue:
    post:
      tags:
      - swarm-receipts
      summary: Issue Receipt
      operationId: issue_receipt_v1_receipt_issue_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueRequestBody'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Issue Receipt V1 Receipt Issue Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/receipt/{receipt_id}:
    get:
      tags:
      - swarm-receipts
      summary: Get Receipt
      operationId: get_receipt_v1_receipt__receipt_id__get
      parameters:
      - name: receipt_id
        in: path
        required: true
        schema:
          type: string
          title: Receipt Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Receipt V1 Receipt  Receipt Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/receipt/settle:
    post:
      tags:
      - swarm-receipts
      summary: Settle Receipt
      operationId: settle_receipt_v1_receipt_settle_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettleRequestBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Settle Receipt V1 Receipt Settle Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    FreeIssueRequestBody:
      properties:
        payload:
          type: string
          maxLength: 8192
          minLength: 1
          title: Payload
          description: Any string to sign (PR diff, contract clause, API log, tx hash, etc).
        label:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Label
          description: Optional human-readable label shown on the verify page.
      type: object
      required:
      - payload
      title: FreeIssueRequestBody
    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
    IssueRequestBody:
      properties:
        tx_hash:
          type: string
          title: Tx Hash
          description: Caller transaction reference
        agent_did:
          type: string
          title: Agent Did
          description: Issuing agent DID
        counterparty_did:
          type: string
          title: Counterparty Did
          description: Counterparty agent DID
        profile:
          type: string
          title: Profile
          description: Receipt profile; must be 'swarm'
          default: swarm
        round_id:
          type: integer
          title: Round Id
          description: Optional federation round ID (0 = auto)
          default: 0
      type: object
      required:
      - tx_hash
      - agent_did
      - counterparty_did
      title: IssueRequestBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    VerifyRequestBody:
      properties:
        envelope:
          additionalProperties: true
          type: object
          title: Envelope
      type: object
      required:
      - envelope
      title: VerifyRequestBody
    SettleRequestBody:
      properties:
        receipt_id:
          type: string
          title: Receipt Id
        settlement_tx_hash:
          type: string
          title: Settlement Tx Hash
      type: object
      required:
      - receipt_id
      - settlement_tx_hash
      title: SettleRequestBody
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)