Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Provebirth API

11 actions 11 updates phrasing extends openapi/thehiveryiq-com-provebirth-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/v1/provebirth/health'].get
$.paths['/v1/provebirth/pricing'].get
$.paths['/v1/provebirth/cert/issue'].post
$.paths['/v1/provebirth/cert/{cert_id}'].get
$.paths['/v1/provebirth/cert/verify'].post
$.paths['/v1/provebirth/action/attest'].post
$.paths['/v1/provebirth/lineage/verify'].post
$.paths['/v1/provebirth/by-agent/{agent_did}'].get
$.paths['/v1/provebirth/by-controller/{controller_did}'].get
$.paths['/v1/provebirth/by-model/{model_pin}'].get

OpenAPI Overlay

Raw ↑
# 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 Provebirth API
  version: 1.0.0
extends: openapi/thehiveryiq-com-provebirth-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/provebirth/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check ProveBirth service health
      effect: read
      questions:
      - Is the ProveBirth agent certificate service up?
      - How do I health-check the birth certificate API?
      instructions:
      - text: Check ProveBirth health.
      - text: Ping the agent birth certificate service.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get ProveBirth pricing
      effect: read
      questions:
      - How much does it cost to issue an agent birth certificate?
      - What does the Cosmic tier cost compared to standard pricing?
      instructions:
      - text: Show ProveBirth pricing.
      - text: List the prices for certificates and action attestations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/cert/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a birth certificate for an AI agent
      effect: write
      questions:
      - How do I issue a birth certificate that pins an agent's model and tool grants?
      - What do I need to provide to certify a newly deployed AI agent?
      instructions:
      - text: Issue a birth certificate for agent {agent_did} under controller {controller_did} running model {model_pin} on {deployment_target}.
        slots:
          agent_did: requestBody.agent_did
          controller_did: requestBody.controller_did
          model_pin: requestBody.model_pin
          deployment_target: requestBody.deployment_target
      - text: Certify agent {agent_did} with tool grants {tool_grants}, policy hash {policy_hash} and training cut-off {training_cut}.
        slots:
          agent_did: requestBody.agent_did
          tool_grants: requestBody.tool_grants
          policy_hash: requestBody.policy_hash
          training_cut: requestBody.training_cut
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/cert/{cert_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an agent birth certificate
      effect: read
      questions:
      - How do I look up an agent birth certificate by its ID?
      - Which model and tool grants were recorded on a certificate?
      instructions:
      - text: Get birth certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      - text: Show what certificate {cert_id} says about the agent.
        slots:
          cert_id: path.cert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/cert/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify the signatures on a birth certificate
      effect: read
      questions:
      - Are the signatures on this agent birth certificate valid?
      - How can I prove a certificate hasn't been tampered with?
      instructions:
      - text: Verify the signatures on certificate {cert_id}.
        slots:
          cert_id: requestBody.cert_id
      - text: Check that birth certificate {cert_id} is authentic.
        slots:
          cert_id: requestBody.cert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/action/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest an action taken by a certified agent
      effect: write
      questions:
      - How do I record a tool call or payment an agent made, chained to its birth certificate?
      - Can I link each agent action to the one before it?
      instructions:
      - text: Attest a {action_type} action by {agent_did} under certificate {birth_cert_id} with hash {action_hash}.
        slots:
          action_type: requestBody.action_type
          agent_did: requestBody.agent_did
          birth_cert_id: requestBody.birth_cert_id
          action_hash: requestBody.action_hash
      - text: Record {agent_did}'s {action_type} (hash {action_hash}, cert {birth_cert_id}) following action {prior_action_id}.
        slots:
          agent_did: requestBody.agent_did
          action_type: requestBody.action_type
          action_hash: requestBody.action_hash
          birth_cert_id: requestBody.birth_cert_id
          prior_action_id: requestBody.prior_action_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/lineage/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an agent's action lineage
      effect: read
      questions:
      - Is an agent's whole chain of actions traceable back to its birth certificate?
      - Can I anchor lineage verification to a specific certificate instead of the latest?
      instructions:
      - text: Verify the lineage of agent {agent_did}.
        slots:
          agent_did: requestBody.agent_did
      - text: Verify {agent_did}'s action chain anchored at certificate {cert_id}.
        slots:
          agent_did: requestBody.agent_did
          cert_id: requestBody.cert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/by-agent/{agent_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificates for an agent
      effect: read
      questions:
      - Which birth certificates have been issued to a particular agent?
      - How do I page through an agent's certificate history?
      instructions:
      - text: List birth certificates for agent {agent_did}.
        slots:
          agent_did: path.agent_did
      - text: Show {limit} certificates for agent {agent_did} starting at {offset}.
        slots:
          limit: query.limit
          agent_did: path.agent_did
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/by-controller/{controller_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificates issued under a controller
      effect: read
      questions:
      - Which agents has my organization certified as their controller?
      - Can I list all birth certificates tied to one controller DID?
      instructions:
      - text: List certificates for controller {controller_did}.
        slots:
          controller_did: path.controller_did
      - text: Show the first {limit} agents certified by controller {controller_did}.
        slots:
          limit: query.limit
          controller_did: path.controller_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/provebirth/by-model/{model_pin}'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificates for a pinned model
      effect: read
      questions:
      - Which certified agents run on a specific pinned model version?
      - How many agents were born on a given model pin?
      instructions:
      - text: List birth certificates pinned to model {model_pin}.
        slots:
          model_pin: path.model_pin
      - text: Show {limit} agents running model {model_pin}.
        slots:
          limit: query.limit
          model_pin: path.model_pin
      method: generated
      generated: '2026-09-26'