# 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 Attest API
  version: 1.0.0
extends: openapi/thehiveryiq-com-attest-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: 20
- target: $.paths['/v1/attest/passport/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a pre-action attestation passport
      effect: write
      questions:
      - How do I get a signed passport declaring what my agent intends to do before it acts?
      - Can a pre-action attestation manifest expire after a set number of seconds?
      - What do I need to supply to issue a hive-passport for an agent action?
      instructions:
      - text: Issue a pre-action passport for agent {agent_did} to run {intended_op} on {target_resource} as action {action_id}.
        slots:
          agent_did: requestBody.agent_did
          intended_op: requestBody.intended_op
          target_resource: requestBody.target_resource
          action_id: requestBody.action_id
      - text: Create a passport manifest for action {action_id} by {agent_did} doing {intended_op} on {target_resource}, valid for {ttl_seconds} seconds.
        slots:
          action_id: requestBody.action_id
          agent_did: requestBody.agent_did
          intended_op: requestBody.intended_op
          target_resource: requestBody.target_resource
          ttl_seconds: requestBody.ttl_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/passport/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a pre-action attestation passport
      effect: read
      questions:
      - How can I check that a pre-action passport manifest is genuine before letting the agent act?
      - Can I compare the inputs an agent actually used against what its passport declared?
      instructions:
      - text: 'Verify this pre-action passport manifest: {manifest}.'
        slots:
          manifest: requestBody.manifest
      - text: 'Check passport {manifest} against the inputs I observed: {observed_inputs}.'
        slots:
          manifest: requestBody.manifest
          observed_inputs: requestBody.observed_inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/custody/append'].post
  update:
    x-apievangelist-phrasing:
      intent: Append a step to a custody chain
      effect: write
      questions:
      - How do I record a new transform step in a data custody chain?
      - Can I mark a custody node as tainted when I append it?
      instructions:
      - text: Append transform {transform_id} by agent {agent_did} to custody chain {chain_id}.
        slots:
          transform_id: requestBody.transform_id
          agent_did: requestBody.agent_did
          chain_id: requestBody.chain_id
      - text: Add a node to custody chain {chain_id} for transform {transform_id} by {agent_did} with taint status {taint_status}.
        slots:
          chain_id: requestBody.chain_id
          transform_id: requestBody.transform_id
          agent_did: requestBody.agent_did
          taint_status: requestBody.taint_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/custody/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a whole custody chain
      effect: read
      questions:
      - How do I confirm a custody chain's hash links and signatures are all intact?
      - Does custody verification check whether taint propagated correctly through the chain?
      instructions:
      - text: 'Verify the custody chain made of these nodes: {nodes}.'
        slots:
          nodes: requestBody.nodes
      - text: Check hash linkage, signatures and taint propagation for custody nodes {nodes}.
        slots:
          nodes: requestBody.nodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/custody/{chain_id}/proof/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Merkle inclusion proof for a custody node
      effect: read
      questions:
      - How do I prove a single node belongs to a custody chain without sharing the whole chain?
      - Can I get a Merkle inclusion proof for a node by its position in the chain?
      instructions:
      - text: Get the inclusion proof for node {index} in custody chain {chain_id}.
        slots:
          index: path.index
          chain_id: path.chain_id
      - text: Fetch a Merkle proof that position {index} is part of chain {chain_id}.
        slots:
          index: path.index
          chain_id: path.chain_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/cargo/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a versioned cargo type
      effect: write
      questions:
      - How do I register a new payload type with a schema and sensitivity level?
      - Can a new cargo type version supersede an older one?
      instructions:
      - text: Register cargo type {id} named {name}, version {version}, sensitivity {sensitivity}, with schema {schema}.
        slots:
          id: requestBody.id
          name: requestBody.name
          version: requestBody.version
          sensitivity: requestBody.sensitivity
          schema: requestBody.schema
      - text: Register version {version} of cargo type {id} ({name}, {sensitivity}) using {schema}, superseding {supersedes}.
        slots:
          version: requestBody.version
          id: requestBody.id
          name: requestBody.name
          sensitivity: requestBody.sensitivity
          schema: requestBody.schema
          supersedes: requestBody.supersedes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/cargo/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a payload against a cargo type
      effect: read
      questions:
      - How do I check a payload conforms to a registered cargo type before sending it?
      - Which cargo type version will my payload be validated against?
      instructions:
      - text: Validate {payload} against cargo type {cargo_type_id} version {version}.
        slots:
          payload: requestBody.payload
          cargo_type_id: requestBody.cargo_type_id
          version: requestBody.version
      - text: 'Check whether this payload fits cargo type {cargo_type_id} v{version}: {payload}.'
        slots:
          cargo_type_id: requestBody.cargo_type_id
          version: requestBody.version
          payload: requestBody.payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/cargo/snapshot'].get
  update:
    x-apievangelist-phrasing:
      intent: Snapshot the cargo type registry
      effect: read
      questions:
      - What cargo types are registered right now?
      - Can I get the Merkle root of the whole cargo taxonomy registry?
      instructions:
      - text: Get a snapshot of the cargo type registry with its Merkle root.
      - text: Show me every registered cargo type.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/warranty/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an attestation warranty for an action
      effect: write
      questions:
      - How do I have an agent warrant a claim about an action it took?
      - Can an attestation warranty be scoped and given an expiry date?
      instructions:
      - text: Issue a warranty from agent {agent_did} for action {action_id} claiming {claim}.
        slots:
          agent_did: requestBody.agent_did
          action_id: requestBody.action_id
          claim: requestBody.claim
      - text: Warrant claim {claim} on action {action_id} by {agent_did}, expiring {expires_at}.
        slots:
          claim: requestBody.claim
          action_id: requestBody.action_id
          agent_did: requestBody.agent_did
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/warranty/breach'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a breach of a warranty
      effect: write
      questions:
      - How do I report that an agent's attestation warranty turned out to be false?
      - Can I attach evidence when filing a warranty breach?
      instructions:
      - text: 'Report a breach of warranty {warranty_id}: {breach_description}.'
        slots:
          warranty_id: requestBody.warranty_id
          breach_description: requestBody.breach_description
      - text: File a breach on warranty {warranty_id} saying {breach_description}, with evidence {evidence}.
        slots:
          warranty_id: requestBody.warranty_id
          breach_description: requestBody.breach_description
          evidence: requestBody.evidence
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/warranty/{warranty_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a warranty by ID
      effect: read
      questions:
      - How do I see the details of a warranty that was issued earlier?
      - Where can I check what claim a given warranty ID covers?
      instructions:
      - text: Get warranty {warranty_id}.
        slots:
          warranty_id: path.warranty_id
      - text: Show me the claim and scope recorded on warranty {warranty_id}.
        slots:
          warranty_id: path.warranty_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/gate/evaluate'].post
  update:
    x-apievangelist-phrasing:
      intent: Decide whether an agent may pass the attest gate
      effect: read
      questions:
      - How do I decide whether an agent is allowed to proceed based on its passport and custody proofs?
      - Do I get a signed receipt even when the gate denies the agent?
      - Can warranties and a cargo manifest be factored into the allow/deny decision?
      instructions:
      - text: Evaluate the gate for passport manifest {passport_manifest}.
        slots:
          passport_manifest: requestBody.passport_manifest
      - text: Decide allow or deny for passport {passport_manifest} with custody root {custody_root} and warranties {warranty_ids}.
        slots:
          passport_manifest: requestBody.passport_manifest
          custody_root: requestBody.custody_root
          warranty_ids: requestBody.warranty_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/inspect/sample'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a random secondary inspection on records
      effect: read
      questions:
      - How can I spot-check a random subset of records instead of inspecting all of them?
      - Can I set the sample rate and a seed so the inspection is reproducible?
      instructions:
      - text: 'Run a secondary inspection on sample {sample_id} over these records: {records}.'
        slots:
          sample_id: requestBody.sample_id
          records: requestBody.records
      - text: Inspect {records} for sample {sample_id} at rate {sample_rate} using seed {seed}.
        slots:
          records: requestBody.records
          sample_id: requestBody.sample_id
          sample_rate: requestBody.sample_rate
          seed: requestBody.seed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/smsh/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an SMSH-Stamp receipt
      effect: read
      questions:
      - How do I check that an SMSH-Stamp v1 receipt is authentic?
      - Can I reject stamp receipts older than a maximum age?
      instructions:
      - text: Verify SMSH-Stamp receipt {receipt}.
        slots:
          receipt: requestBody.receipt
      - text: Verify stamp receipt {receipt} with public key {pubkey_b64url}, rejecting it if older than {max_age_seconds} seconds.
        slots:
          receipt: requestBody.receipt
          pubkey_b64url: requestBody.pubkey_b64url
          max_age_seconds: requestBody.max_age_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/absence/build'].post
  update:
    x-apievangelist-phrasing:
      intent: Build an audit window tree for absence proofs
      effect: write
      questions:
      - How do I seal a window of audit events so I can later prove something did not happen?
      - What do I need to build a sorted Merkle tree for an audit window?
      instructions:
      - text: 'Build the audit window {window_id} from these events: {events}.'
        slots:
          window_id: requestBody.window_id
          events: requestBody.events
      - text: Seal events {events} into a sorted Merkle tree as window {window_id}.
        slots:
          events: requestBody.events
          window_id: requestBody.window_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/absence/prove'].post
  update:
    x-apievangelist-phrasing:
      intent: Prove an event is absent from an audit window
      effect: read
      questions:
      - Can I prove a particular event never appeared in an audit window?
      - How do I get a non-membership proof for an event?
      instructions:
      - text: Prove that event {query} is absent from audit window {window_id}.
        slots:
          query: requestBody.query
          window_id: requestBody.window_id
      - text: Generate a non-membership proof for {query} in window {window_id}.
        slots:
          query: requestBody.query
          window_id: requestBody.window_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/absence/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a non-membership proof
      effect: read
      questions:
      - How do I check someone's absence proof against the audit window root I trust?
      - What happens if a non-membership proof doesn't match the expected root?
      instructions:
      - text: Verify absence proof {proof} against root {root_hex}.
        slots:
          proof: requestBody.proof
          root_hex: requestBody.root_hex
      - text: Check that non-membership proof {proof} is valid for window root {root_hex}.
        slots:
          proof: requestBody.proof
          root_hex: requestBody.root_hex
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/sanctions/screen'].post
  update:
    x-apievangelist-phrasing:
      intent: Screen a name against sanctions and PEP lists
      effect: read
      questions:
      - How do I check a person or company against sanctions and PEP lists before my agent transacts?
      - Can I narrow a sanctions screen by country or adjust the match threshold?
      - Does a sanctions screening return a signed receipt I can keep for audit?
      instructions:
      - text: Screen {name} against sanctions and PEP lists.
        slots:
          name: requestBody.name
      - text: Run a sanctions check on {name} in {country} with match threshold {threshold}.
        slots:
          name: requestBody.name
          country: requestBody.country
          threshold: requestBody.threshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/agentkit/lookup'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if an agent wallet is human-backed
      effect: read
      questions:
      - How can I tell whether an agent's wallet is registered as human-backed in AgentBook?
      - Is the AgentKit lookup read directly from the chain?
      instructions:
      - text: Look up wallet {address} in AgentBook.
        slots:
          address: requestBody.address
      - text: Check whether agent wallet {address} is backed by a registered human.
        slots:
          address: requestBody.address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attest/address/screen'].post
  update:
    x-apievangelist-phrasing:
      intent: Screen a crypto address for risk
      effect: read
      questions:
      - How do I check a wallet address for scam, phishing or other risk flags before paying it?
      - Can I screen an on-chain address on a specific chain?
      instructions:
      - text: Screen address {address} for on-chain risk.
        slots:
          address: requestBody.address
      - text: Run a risk screen on wallet {address} on chain {chain_id}.
        slots:
          address: requestBody.address
          chain_id: requestBody.chain_id
      method: generated
      generated: '2026-09-26'