Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Activation API

5 actions 5 updates phrasing extends openapi/thehiveryiq-com-activation-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 5

$.info
$.paths['/v1/activation/keys'].get
$.paths['/v1/activation/keys'].post
$.paths['/v1/activation/verify'].post
$.paths['/v1/activation/keys/{key_id}'].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 Activation API
  version: 1.0.0
extends: openapi/thehiveryiq-com-activation-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: 4
- target: $.paths['/v1/activation/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: Learn how to get an activation key
      effect: read
      questions:
      - What does a tk_live activation key cost and which scopes can it have?
      - Which auth methods are accepted for minting a key?
      instructions:
      - text: Show me how activation keys are minted.
      - text: List activation key scopes and price.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/activation/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Mint a tk_live activation key
      effect: write
      questions:
      - How do I get a new tk_live activation key after paying with x402?
      - Can I cap how many verifications a new key will serve?
      instructions:
      - text: Mint an activation key labeled {label}.
        slots:
          label: requestBody.label
      - text: Mint a key with scopes {scopes} and a usage limit of {usage_limit}.
        slots:
          scopes: requestBody.scopes
          usage_limit: requestBody.usage_limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/activation/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an activation key
      effect: read
      questions:
      - Is this tk_live key valid and not revoked or over its limit?
      - Does verifying an activation key count against its usage?
      instructions:
      - text: Verify activation key {key}.
        slots:
          key: requestBody.key
      - text: Check that {key} is still a valid key.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/activation/keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activation key's metadata
      effect: read
      questions:
      - Which scopes and usage does a given activation key have?
      - Who issued an activation key, without revealing the secret?
      instructions:
      - text: Show metadata for key {key_id}.
        slots:
          key_id: path.key_id
      - text: Get the scopes and usage of key {key_id}.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-09-26'