Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Cre API
12 actions
12 updates
phrasing
extends
openapi/thehiveryiq-com-cre-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 12
$.info
$.paths['/v1/cre/health'].get
$.paths['/v1/cre/issue'].post
$.paths['/v1/cre/envelope/{cre_id}'].get
$.paths['/v1/cre/verify'].post
$.paths['/v1/cre/coverage'].get
$.paths['/v1/cre/tbr/manifest'].get
$.paths['/v1/cre/tbr/perf'].get
$.paths['/v1/cre/tbr/kem/generate'].post
$.paths['/v1/cre/tbr/kem/selftest'].get
$.paths['/v1/cre/tbr/entropy/health'].get
$.paths['/v1/cre/manifesto'].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 Cre API
version: 1.0.0
extends: openapi/thehiveryiq-com-cre-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: 11
- target: $.paths['/v1/cre/health'].get
update:
x-apievangelist-phrasing:
intent: Check CRE service health
effect: read
questions:
- Is the compliance receipt envelope service running?
- How do I health-check the CRE endpoints?
instructions:
- text: Check the health of the CRE service.
- text: Ping the compliance receipt envelope health endpoint.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/issue'].post
update:
x-apievangelist-phrasing:
intent: Issue a compliance receipt envelope for a transaction
effect: write
questions:
- How do I issue a compliance receipt envelope for a transaction?
- Can I attest specific controls or extra frameworks when issuing an envelope?
- What should I send instead of PHI or PII in the transaction payload?
instructions:
- text: Issue a CRE envelope for a {txn_type} transaction initiated by {actor}.
slots:
txn_type: requestBody.txn_type
actor: requestBody.actor
- text: Issue a CRE for {txn_type} from {actor} to {counterparty} governed by jurisdictions {jurisdictions}.
slots:
txn_type: requestBody.txn_type
actor: requestBody.actor
counterparty: requestBody.counterparty
jurisdictions: requestBody.jurisdictions
- text: Issue an envelope for {txn_type} by {actor} with sealed record hash {payload_hash}.
slots:
txn_type: requestBody.txn_type
actor: requestBody.actor
payload_hash: requestBody.payload_hash
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/envelope/{cre_id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a compliance receipt envelope
effect: read
questions:
- How do I fetch a CRE envelope I issued earlier?
- What controls and frameworks did a specific envelope attest?
instructions:
- text: Get CRE envelope {cre_id}.
slots:
cre_id: path.cre_id
- text: Show the contents of compliance envelope {cre_id}.
slots:
cre_id: path.cre_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/verify'].post
update:
x-apievangelist-phrasing:
intent: Verify a compliance receipt envelope
effect: read
questions:
- How can I check that a CRE envelope is authentic and untampered?
- Can I verify an envelope by passing it inline rather than by ID?
instructions:
- text: Verify this CRE envelope.
- text: Check the signatures on a compliance receipt envelope I paste in.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/coverage'].get
update:
x-apievangelist-phrasing:
intent: Show per-framework control coverage
effect: read
questions:
- What percentage of SOC 2 or HIPAA controls have been attested by real transactions?
- How much of each compliance framework is covered by issued envelopes?
instructions:
- text: Show control coverage per framework across all envelopes.
- text: Report which frameworks have the least attested coverage.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/tbr/manifest'].get
update:
x-apievangelist-phrasing:
intent: Disclose the deployed TBR cryptographic stack
effect: read
questions:
- Which cryptographic constructions does the TBR stack actually use?
- What cryptography is explicitly not used by TBR?
instructions:
- text: Show the TBR cryptographic manifest.
- text: List the crypto primitives deployed and those ruled out in TBR.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/tbr/perf'].get
update:
x-apievangelist-phrasing:
intent: Measure live TBR primitive performance
effect: read
questions:
- How fast are the TBR primitives in practice?
- Can I see live measured timings for the TBR crypto operations?
instructions:
- text: Measure TBR primitive performance now.
- text: Show live timing telemetry for the TBR primitives.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/tbr/kem/generate'].post
update:
x-apievangelist-phrasing:
intent: Generate an ephemeral hybrid-KEM keypair
effect: write
questions:
- How do I get a one-time hybrid KEM public key to encapsulate against?
- How long is the server-side KEM secret key kept?
instructions:
- text: Generate a one-shot hybrid-KEM keypair.
- text: Create an ephemeral KEM public key and give me its kem_id.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/tbr/kem/selftest'].get
update:
x-apievangelist-phrasing:
intent: Self-test the hybrid-KEM combiner
effect: read
questions:
- Does the hybrid-KEM combiner derive matching shared secrets?
- How can I sanity-check the KEM encapsulate and decapsulate round trip?
instructions:
- text: Run the hybrid-KEM self-test.
- text: Test a KEM encapsulate/decapsulate round trip and report timing.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/tbr/entropy/health'].get
update:
x-apievangelist-phrasing:
intent: Check operational entropy health
effect: read
questions:
- Is the entropy source feeding TBR healthy?
- Does the entropy health telemetry amount to a FIPS 140-3 claim?
instructions:
- text: Show entropy health telemetry.
- text: Check the TBR entropy source status.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/cre/manifesto'].get
update:
x-apievangelist-phrasing:
intent: Read the CRE manifesto
effect: read
questions:
- What principles is the compliance receipt envelope built on?
- Where is the CRE manifesto published?
instructions:
- text: Show the CRE manifesto.
- text: Fetch the compliance receipt envelope manifesto.
method: generated
generated: '2026-09-26'