Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com R6 Hivememory API

7 actions 7 updates phrasing extends openapi/thehiveryiq-com-r6-hivememory-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 7

$.info

$.paths['/v1/memory/policy'].get

$.paths['/v1/memory/write'].post

$.paths['/v1/memory/list'].get

$.paths['/v1/memory/revoke/{mid}'].post

$.paths['/v1/memory/export/{agent_did}'].get

$.paths['/v1/memory/{mid}'].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 R6 Hivememory API
  version: 1.0.0
extends: openapi/thehiveryiq-com-r6-hivememory-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: 6
- target: $.paths['/v1/memory/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the agent memory policy
      effect: read
      questions:
      - What rules govern what agents can store in HiveMemory?
      - Which memory kinds and scopes does the policy allow?
      instructions:
      - text: Show me the HiveMemory policy.
      - text: Get the rules for agent memory.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memory/write'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a memory for an agent
      effect: write
      questions:
      - How do I save a memory record for my agent with provenance?
      - Can a memory have tags, a scope and an expiry date?
      instructions:
      - text: Write a {kind} memory for agent {agent_did} under operator {operator_did}.
        slots:
          kind: requestBody.kind
          agent_did: requestBody.agent_did
          operator_did: requestBody.operator_did
      - text: Store {payload} as a {kind} memory for {agent_did}, operator {operator_did}, expiring {expires_at}.
        slots:
          payload: requestBody.payload
          kind: requestBody.kind
          agent_did: requestBody.agent_did
          operator_did: requestBody.operator_did
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memory/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent memories
      effect: read
      questions:
      - What memories has an agent stored, filtered by kind or scope?
      - Can I include revoked memories when listing?
      instructions:
      - text: List memories for agent {agent_did}.
        slots:
          agent_did: query.agent_did
      - text: List {kind} memories in scope {scope}.
        slots:
          kind: query.kind
          scope: query.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memory/revoke/{mid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an agent memory
      effect: destructive
      questions:
      - How do I revoke a memory so the agent stops using it?
      - Can a stored memory be withdrawn after it's written?
      instructions:
      - text: Revoke memory {mid}.
        slots:
          mid: path.mid
      - text: Withdraw agent memory {mid}.
        slots:
          mid: path.mid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memory/export/{agent_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export all of an agent's memories
      effect: read
      questions:
      - Can I export everything an agent remembers in one go?
      - Does the memory export include revoked entries?
      instructions:
      - text: Export memories for agent {agent_did}.
        slots:
          agent_did: path.agent_did
      - text: Export {agent_did}'s memories in scope {scope}, revoked ones included.
        slots:
          agent_did: path.agent_did
          scope: query.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/memory/{mid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one agent memory
      effect: read
      questions:
      - What does a specific stored memory contain?
      - Can I fetch a single memory by its ID?
      instructions:
      - text: Show memory {mid}.
        slots:
          mid: path.mid
      - text: Get the memory record {mid}.
        slots:
          mid: path.mid
      method: generated
      generated: '2026-09-26'