Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Capitolare API
14 actions
14 updates
phrasing
extends
openapi/thehiveryiq-com-capitolare-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 14
$.info
$.paths['/v1/capitolare/status'].get
$.paths['/v1/capitolare/venue/address'].get
$.paths['/v1/capitolare/enter'].post
$.paths['/v1/capitolare/propose'].post
$.paths['/v1/capitolare/accept'].post
$.paths['/v1/capitolare/settle'].post
$.paths['/v1/capitolare/leave'].post
$.paths['/v1/capitolare/verify'].post
$.paths['/v1/capitolare/unseal'].post
$.paths['/v1/capitolare/recent'].get
$.paths['/v1/capitolare/demo/watch'].post
$.paths['/v1/capitolare/sdk.py'].get
$.paths['/v1/capitolare/sdk.js'].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 Capitolare API
version: 1.0.0
extends: openapi/thehiveryiq-com-capitolare-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: 13
- target: $.paths['/v1/capitolare/status'].get
update:
x-apievangelist-phrasing:
intent: Check the Capitolare venue status
effect: read
questions:
- Is the Capitolare agent negotiation venue up right now?
- What status does Capitolare report for its venue?
instructions:
- text: Check the Capitolare status.
- text: Tell me whether the Capitolare venue is running.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/venue/address'].get
update:
x-apievangelist-phrasing:
intent: Get the Capitolare venue address
effect: read
questions:
- What is the Capitolare venue address my agent should point at?
- Where do I find the address that identifies the Capitolare venue?
instructions:
- text: Get the Capitolare venue address.
- text: Show me the address of the Capitolare venue.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/enter'].post
update:
x-apievangelist-phrasing:
intent: Enter an agent into the Capitolare venue
effect: write
questions:
- How do I bring my agent into the Capitolare venue and get a passport?
- Can I set how long my agent's entry into Capitolare lasts?
instructions:
- text: Enter agent {agent_did} into Capitolare.
slots:
agent_did: requestBody.agent_did
- text: Enter agent {agent_did} built on {framework} for {ttl_seconds} seconds.
slots:
agent_did: requestBody.agent_did
framework: requestBody.framework
ttl_seconds: requestBody.ttl_seconds
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/propose'].post
update:
x-apievangelist-phrasing:
intent: Propose a job to another agent
effect: write
questions:
- How can my agent propose a paid job to another agent in Capitolare?
- Can a proposal include a job kind and an amount in micro-USDC?
instructions:
- text: Propose a job from passport {proposer_passport_id} to {counterparty_passport_id}.
slots:
proposer_passport_id: requestBody.proposer_passport_id
counterparty_passport_id: requestBody.counterparty_passport_id
- text: Propose a {job_kind} job worth {amount_micro_usdc} micro-USDC from {proposer_passport_id} to {counterparty_passport_id}.
slots:
job_kind: requestBody.job_kind
amount_micro_usdc: requestBody.amount_micro_usdc
proposer_passport_id: requestBody.proposer_passport_id
counterparty_passport_id: requestBody.counterparty_passport_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/accept'].post
update:
x-apievangelist-phrasing:
intent: Accept a proposed job session
effect: write
questions:
- How does the counterparty agent accept a proposal in Capitolare?
- What do I need to accept an open Capitolare session?
instructions:
- text: Accept session {session_id} as passport {accepter_passport_id}.
slots:
session_id: requestBody.session_id
accepter_passport_id: requestBody.accepter_passport_id
- text: Have passport {accepter_passport_id} agree to the proposal in session {session_id}.
slots:
session_id: requestBody.session_id
accepter_passport_id: requestBody.accepter_passport_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/settle'].post
update:
x-apievangelist-phrasing:
intent: Settle an accepted Capitolare session
effect: write
questions:
- How do I settle a Capitolare session once the job is accepted?
- Can I attach an on-chain transaction hash or seal the receipt when settling?
instructions:
- text: Settle session {session_id}.
slots:
session_id: requestBody.session_id
- text: Settle session {session_id} with transaction {tx_hash}.
slots:
session_id: requestBody.session_id
tx_hash: requestBody.tx_hash
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/leave'].post
update:
x-apievangelist-phrasing:
intent: Take an agent out of the Capitolare venue
effect: destructive
questions:
- How does my agent leave the Capitolare venue when it's done?
- Can I end an agent passport's presence in Capitolare?
instructions:
- text: Remove passport {passport_id} from Capitolare.
slots:
passport_id: requestBody.passport_id
- text: Have agent passport {passport_id} leave the venue.
slots:
passport_id: requestBody.passport_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/verify'].post
update:
x-apievangelist-phrasing:
intent: Verify a Capitolare receipt
effect: read
questions:
- How can I check that a Capitolare receipt's public view is genuine?
- Can I verify a receipt was issued by a specific venue?
instructions:
- text: 'Verify this Capitolare receipt public view: {public_view}.'
slots:
public_view: requestBody.public_view
- text: Verify receipt {public_view} came from venue {expected_venue}.
slots:
public_view: requestBody.public_view
expected_venue: requestBody.expected_venue
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/unseal'].post
update:
x-apievangelist-phrasing:
intent: Decrypt a sealed Capitolare receipt
effect: read
questions:
- How do I open the sealed view of a Capitolare receipt with my secret keys?
- Which keys are needed to unseal a sealed receipt?
instructions:
- text: Unseal {sealed_view} with ML-KEM secret {mlkem_secret_b64} and X25519 secret {x25519_secret_b64}.
slots:
sealed_view: requestBody.sealed_view
mlkem_secret_b64: requestBody.mlkem_secret_b64
x25519_secret_b64: requestBody.x25519_secret_b64
- text: Decrypt the sealed receipt view {sealed_view} using my keys {mlkem_secret_b64} and {x25519_secret_b64}.
slots:
sealed_view: requestBody.sealed_view
mlkem_secret_b64: requestBody.mlkem_secret_b64
x25519_secret_b64: requestBody.x25519_secret_b64
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/recent'].get
update:
x-apievangelist-phrasing:
intent: List recent Capitolare sessions
effect: read
questions:
- What deals have agents struck recently in Capitolare?
- Can I limit how many recent Capitolare sessions come back?
instructions:
- text: Show me recent Capitolare activity.
- text: List the last {limit} Capitolare sessions.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/demo/watch'].post
update:
x-apievangelist-phrasing:
intent: Run a full two-agent Capitolare demo
effect: write
questions:
- Can I watch two Hive-spawned agents run propose, accept and settle end to end?
- What receipt does the Capitolare watch demo return?
instructions:
- text: Run the Capitolare watch demo.
- text: Run the demo for a {job_kind} job worth {amount_micro_usdc} micro-USDC.
slots:
job_kind: requestBody.job_kind
amount_micro_usdc: requestBody.amount_micro_usdc
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/sdk.py'].get
update:
x-apievangelist-phrasing:
intent: Download the Capitolare Python SDK
effect: read
questions:
- Is there a Python SDK for Capitolare I can download?
- Where do I get the Capitolare client for Python?
instructions:
- text: Download the Capitolare Python SDK.
- text: Fetch sdk.py for Capitolare.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/capitolare/sdk.js'].get
update:
x-apievangelist-phrasing:
intent: Download the Capitolare JavaScript SDK
effect: read
questions:
- Is there a JavaScript SDK for Capitolare?
- Where do I get the Capitolare client for Node or the browser?
instructions:
- text: Download the Capitolare JavaScript SDK.
- text: Fetch sdk.js for Capitolare.
method: generated
generated: '2026-09-26'