Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Procurelock API
13 actions
13 updates
phrasing
extends
openapi/thehiveryiq-com-procurelock-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 13
$.info
$.paths['/v1/procurelock/mcp'].get
$.paths['/v1/procurelock/mcp'].post
$.paths['/v1/procurelock/health'].get
$.paths['/v1/procurelock/pricing'].get
$.paths['/v1/procurelock/po_attest'].post
$.paths['/v1/procurelock/po_get/{attestation_id}'].get
$.paths['/v1/procurelock/po_verify/{attestation_id}'].get
$.paths['/v1/procurelock/delivery_attest'].post
$.paths['/v1/procurelock/match_verify'].post
$.paths['/v1/procurelock/by-buyer/{buyer_did}'].get
$.paths['/v1/procurelock/by-supplier/{supplier_did}'].get
$.paths['/v1/procurelock/by-po/{po_number}'].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 Procurelock API
version: 1.0.0
extends: openapi/thehiveryiq-com-procurelock-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: 12
- target: $.paths['/v1/procurelock/mcp'].get
update:
x-apievangelist-phrasing:
intent: Describe the ProcureLock MCP server
effect: read
questions:
- What does the ProcureLock MCP server expose to agents?
- Where can I read the metadata for the ProcureLock MCP endpoint?
instructions:
- text: Show the ProcureLock MCP server metadata.
- text: Describe the ProcureLock MCP endpoint.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/mcp'].post
update:
x-apievangelist-phrasing:
intent: Call the ProcureLock MCP server
effect: write
questions:
- How do I send an MCP request to ProcureLock?
- Can my agent invoke ProcureLock tools over MCP?
instructions:
- text: Send this MCP request to the ProcureLock server.
- text: Invoke a ProcureLock tool through its MCP endpoint.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/health'].get
update:
x-apievangelist-phrasing:
intent: Check ProcureLock health
effect: read
questions:
- Is the ProcureLock purchase-order attestation service up?
- Can I check whether ProcureLock is healthy before attesting a PO?
instructions:
- text: Check ProcureLock health.
- text: Ping the ProcureLock service status.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/pricing'].get
update:
x-apievangelist-phrasing:
intent: Get ProcureLock pricing
effect: read
questions:
- What does it cost to attest a purchase order or delivery with ProcureLock?
- Is Cosmic tier priced differently in ProcureLock?
instructions:
- text: Show ProcureLock pricing.
- text: List the prices for PO and delivery attestations.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/po_attest'].post
update:
x-apievangelist-phrasing:
intent: Attest a purchase order event
effect: write
questions:
- How do I create a signed attestation for a purchase order?
- Can the PO attestation receipt come back wrapped as an X12 or EDIFACT document?
- Which ERP systems can I tag a purchase order attestation with?
instructions:
- text: Attest PO {po_number} from buyer {buyer_did} to supplier {supplier_did} for event {event_type} with hash {event_hash}.
slots:
po_number: requestBody.po_number
buyer_did: requestBody.buyer_did
supplier_did: requestBody.supplier_did
event_type: requestBody.event_type
event_hash: requestBody.event_hash
- text: Attest PO {po_number} for {total_amount_cents} cents in {currency} under {incoterms} incoterms.
slots:
po_number: requestBody.po_number
total_amount_cents: requestBody.total_amount_cents
currency: requestBody.currency
incoterms: requestBody.incoterms
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/po_get/{attestation_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a purchase order attestation
effect: read
questions:
- How do I retrieve a PO attestation record by its id?
- What was stored in a purchase order attestation I created?
instructions:
- text: Get PO attestation {attestation_id}.
slots:
attestation_id: path.attestation_id
- text: Show the purchase order attestation record {attestation_id}.
slots:
attestation_id: path.attestation_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/po_verify/{attestation_id}'].get
update:
x-apievangelist-phrasing:
intent: Verify a purchase order attestation
effect: read
questions:
- Can I prove a purchase order attestation's signature is valid?
- How do I check that a PO attestation hasn't been tampered with?
instructions:
- text: Verify PO attestation {attestation_id}.
slots:
attestation_id: path.attestation_id
- text: Check the signature on attestation {attestation_id}.
slots:
attestation_id: path.attestation_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/delivery_attest'].post
update:
x-apievangelist-phrasing:
intent: Attest a delivery against a purchase order
effect: write
questions:
- How do I record a goods-received attestation for a purchase order?
- Can a delivery attestation capture inspection results and received quantities?
instructions:
- text: Attest delivery for PO {po_number} from {supplier_did} to {buyer_did} with status {delivery_status}.
slots:
po_number: requestBody.po_number
supplier_did: requestBody.supplier_did
buyer_did: requestBody.buyer_did
delivery_status: requestBody.delivery_status
- text: Record receipt of {received_qty} units on PO {po_number} under bill of lading {bol_number}.
slots:
received_qty: requestBody.received_qty
po_number: requestBody.po_number
bol_number: requestBody.bol_number
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/match_verify'].post
update:
x-apievangelist-phrasing:
intent: Run a three-way match on a purchase order
effect: read
questions:
- Does a purchase order pass three-way match between PO, goods receipt and invoice?
- Can I accept a two-way match that skips the goods receipt?
instructions:
- text: Verify the match for PO {po_number}.
slots:
po_number: requestBody.po_number
- text: Run a two-way match on PO {po_number} with {require_two_way}.
slots:
po_number: requestBody.po_number
require_two_way: requestBody.require_two_way
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/by-buyer/{buyer_did}'].get
update:
x-apievangelist-phrasing:
intent: List attestations for a buyer
effect: read
questions:
- Which PO attestations has a buying organization recorded?
- Can I page through a buyer's procurement attestations?
instructions:
- text: List attestations for buyer {buyer_did}.
slots:
buyer_did: path.buyer_did
- text: Show {limit} attestations for buyer {buyer_did} starting at {offset}.
slots:
limit: query.limit
buyer_did: path.buyer_did
offset: query.offset
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/by-supplier/{supplier_did}'].get
update:
x-apievangelist-phrasing:
intent: List attestations for a supplier
effect: read
questions:
- Which attestations involve a particular supplier?
- Can I page through every PO attestation for one supplier?
instructions:
- text: List attestations for supplier {supplier_did}.
slots:
supplier_did: path.supplier_did
- text: Show {limit} attestations for supplier {supplier_did} from offset {offset}.
slots:
limit: query.limit
supplier_did: path.supplier_did
offset: query.offset
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/procurelock/by-po/{po_number}'].get
update:
x-apievangelist-phrasing:
intent: List attestations for a PO number
effect: read
questions:
- What attestations exist for a given purchase order number?
- How do I see the full attestation history of one PO?
instructions:
- text: List attestations for PO number {po_number}.
slots:
po_number: path.po_number
- text: Show the attestation trail for purchase order {po_number}.
slots:
po_number: path.po_number
method: generated
generated: '2026-09-26'