Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Organic API
11 actions
11 updates
phrasing
extends
openapi/thehiveryiq-com-organic-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/v1/rosetta/normalize'].post
$.paths['/v1/prospector/score'].post
$.paths['/v1/hktn/lookup'].get
$.paths['/v1/hktn/register'].post
$.paths['/v1/rubric/select'].post
$.paths['/v1/settlement/reference'].get
$.paths['/v1/receipt/emit'].get
$.paths['/v1/receipt/emit'].post
$.paths['/v1/receipt/benchmark'].get
$.paths['/v1/pricing'].get
OpenAPI Overlay
# 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 Organic API
version: 1.0.0
extends: openapi/thehiveryiq-com-organic-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: 10
- target: $.paths['/v1/rosetta/normalize'].post
update:
x-apievangelist-phrasing:
intent: Normalize free-form input to a canonical schema
effect: read
questions:
- Can I turn a messy natural-language request into a canonical intent, quote or route?
- How do I normalize input written in another locale into the canonical schema?
instructions:
- text: Normalize {input} into the canonical {target} schema.
slots:
input: requestBody.input
target: requestBody.target
- text: Normalize {input} written in locale {locale}.
slots:
input: requestBody.input
locale: requestBody.locale
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/prospector/score'].post
update:
x-apievangelist-phrasing:
intent: Score an agent's intent as a prospect
effect: read
questions:
- How promising is an agent as a prospect given what it wants to do?
- Can I get a prospector score for an agent DID and its stated intent?
instructions:
- text: Score agent {agent_did} as a prospect for intent {intent}.
slots:
agent_did: requestBody.agent_did
intent: requestBody.intent
- text: Rate prospect {agent_did} wanting {intent} given context {context}.
slots:
agent_did: requestBody.agent_did
intent: requestBody.intent
context: requestBody.context
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hktn/lookup'].get
update:
x-apievangelist-phrasing:
intent: Look up an HKTN registration
effect: read
questions:
- What HKTN tier is an agent registered under?
- Can I find an HKTN record by its hktn id or by agent DID?
instructions:
- text: Look up HKTN {hktn}.
slots:
hktn: query.hktn
- text: Find the HKTN registration for agent {agent_did}.
slots:
agent_did: query.agent_did
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/hktn/register'].post
update:
x-apievangelist-phrasing:
intent: Submit an HKTN registration intent
effect: write
questions:
- How does an agent register for an HKTN tier and see the x402 discount it could earn?
- Can I self-claim a Warm or Hot HKTN tier when registering?
instructions:
- text: Register agent {agent_did} for HKTN.
slots:
agent_did: requestBody.agent_did
- text: Register {agent_did} for HKTN requesting tier {requested_tier}, vouched by operator {operator_did}.
slots:
agent_did: requestBody.agent_did
requested_tier: requestBody.requested_tier
operator_did: requestBody.operator_did
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/rubric/select'].post
update:
x-apievangelist-phrasing:
intent: Select the rubric for an intent
effect: read
questions:
- Which evaluation rubric applies to a given intent and amount?
- Can constraints change which rubric gets picked for my request?
instructions:
- text: Select a rubric for intent {intent}.
slots:
intent: requestBody.intent
- text: Pick the rubric for {intent} at {amount_usd} USD with constraints {constraints}.
slots:
intent: requestBody.intent
amount_usd: requestBody.amount_usd
constraints: requestBody.constraints
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/settlement/reference'].get
update:
x-apievangelist-phrasing:
intent: Generate a USDC settlement reference
effect: read
questions:
- How do I get a settlement reference for paying an amount in USDC?
- Can I attach a short memo to a USDC settlement reference?
instructions:
- text: Get a settlement reference for {amount_usdc} USDC.
slots:
amount_usdc: query.amount_usdc
- text: Create a settlement reference for {amount_usdc} USDC with memo {memo}.
slots:
amount_usdc: query.amount_usdc
memo: query.memo
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/receipt/emit'].get
update:
x-apievangelist-phrasing:
intent: Preflight the receipt emit endpoint
effect: read
questions:
- What do I need to send before emitting a signed receipt?
- Can I check what a given receipt profile requires without writing anything?
instructions:
- text: Preflight receipt emission.
- text: Preflight emitting a {profile} receipt.
slots:
profile: query.profile
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/receipt/emit'].post
update:
x-apievangelist-phrasing:
intent: Emit a signed receipt for an artifact
effect: write
questions:
- How does an agent get a signed receipt over an artifact it produced?
- Which receipt profiles exist, and when is a delegation envelope required?
instructions:
- text: Emit a receipt for artifact {artifact} from agent {agent_did}.
slots:
artifact: requestBody.artifact
agent_did: requestBody.agent_did
- text: Emit a post-quantum receipt for {artifact} from {agent_did} using envelope {regulated_envelope_jti} and profile {profile}.
slots:
artifact: requestBody.artifact
agent_did: requestBody.agent_did
regulated_envelope_jti: requestBody.regulated_envelope_jti
profile: query.profile
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/receipt/benchmark'].get
update:
x-apievangelist-phrasing:
intent: Benchmark the receipt signing path
effect: read
questions:
- How long does it take to hash, sign and verify a receipt end to end?
- Can I see per-phase timing for the post-quantum receipt profile?
instructions:
- text: Run the receipt benchmark.
- text: Benchmark the {profile} receipt profile.
slots:
profile: query.profile
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/pricing'].get
update:
x-apievangelist-phrasing:
intent: Get receipt and service pricing
effect: read
questions:
- What are the published prices for Hive's receipt services?
- Where is the pricing table for the core API?
instructions:
- text: Show the pricing table.
- text: Get current service pricing.
method: generated
generated: '2026-09-26'