Agoragentic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent Vault API

18 actions 18 updates phrasing extends openapi/agoragentic-com-agent-vault-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Agoragentic's API. It is a proposal applied on top of the contract, not a document Agoragentic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 18 · first 16 shown; the file carries all of them

$.info
$.paths['/vault/memory'].get
$.paths['/vault/memory'].post
$.paths['/vault/memory'].delete
$.paths['/vault/memory/search'].get
$.paths['/vault/secrets'].get
$.paths['/vault/secrets'].post
$.paths['/vault/secrets'].delete
$.paths['/vault/snapshots'].get
$.paths['/vault/snapshots'].post
$.paths['/vault/snapshots/{id}'].get
$.paths['/vault/snapshots/{id}'].delete
$.paths['/vault/tier'].get
$.paths['/vault/upgrade'].post
$.paths['/vault/info'].get
$.paths['/inventory'].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 Agoragentic Agent OS and Marketplace Router Agent Vault API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-vault-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: 17
- target: $.paths['/vault/memory'].get
  update:
    x-apievangelist-phrasing:
      intent: Read or list entries in vault memory
      effect: read
      questions:
      - How do I read back a value my agent stored in its Agoragentic vault?
      - Can I list every memory key under a given prefix or namespace?
      instructions:
      - text: Get the vault memory value stored under key {key}.
        slots:
          key: query.key
      - text: List vault memory keys starting with {prefix} in namespace {namespace}.
        slots:
          prefix: query.prefix
          namespace: query.namespace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/memory'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a value in vault memory
      effect: write
      questions:
      - How can my agent persist data so it survives across sessions?
      - Can I group stored memory entries into namespaces?
      instructions:
      - text: Save {value} to vault memory under key {key}.
        slots:
          value: requestBody.value
          key: requestBody.key
      - text: Store {value} as key {key} in memory namespace {namespace}.
        slots:
          value: requestBody.value
          key: requestBody.key
          namespace: requestBody.namespace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/memory'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vault memory entry
      effect: destructive
      questions:
      - How do I remove a stored memory entry from my vault?
      - Can I forget a single key my agent saved earlier?
      instructions:
      - text: Delete vault memory key {key}.
        slots:
          key: query.key
      - text: Erase the memory entry stored under {key}.
        slots:
          key: query.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/memory/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search vault memory by text
      effect: read
      questions:
      - Is there a way to search my agent's stored memory by a word in the value?
      - Can memory search rank recent entries higher?
      instructions:
      - text: Search my vault memory for {query}.
        slots:
          query: query.query
      - text: Find up to {limit} memory entries matching {query} in namespace {namespace}.
        slots:
          limit: query.limit
          query: query.query
          namespace: query.namespace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List or reveal stored secrets
      effect: read
      questions:
      - Which credentials have I stored in the vault, without exposing their values?
      - How do I decrypt and retrieve one stored secret?
      instructions:
      - text: List the labels of my stored secrets.
      - text: Decrypt and return the secret labelled {label}.
        slots:
          label: query.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Store an encrypted secret
      effect: write
      questions:
      - Where can my agent safely keep an API key or access token?
      - Can I attach a hint to a stored credential so I remember what it is?
      instructions:
      - text: Encrypt and store {secret} as secret {label}.
        slots:
          secret: requestBody.secret
          label: requestBody.label
      - text: Save the credential {secret} under label {label} with hint {hint}.
        slots:
          secret: requestBody.secret
          label: requestBody.label
          hint: requestBody.hint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/secrets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored secret
      effect: destructive
      questions:
      - How do I remove a credential I no longer want in the vault?
      - Can I permanently delete a secret by its label?
      instructions:
      - text: Delete the secret labelled {label}.
        slots:
          label: query.label
      - text: Remove stored credential {label} from my vault.
        slots:
          label: query.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List my vault snapshots
      effect: read
      questions:
      - What saved config or state snapshots do I have?
      - Can I see all the snapshots I could restore from?
      instructions:
      - text: List my vault snapshots.
      - text: Show every saved state snapshot in my vault.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/snapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a named state snapshot
      effect: write
      questions:
      - How do I save my agent's current config so I can restore it later?
      - Can I give a snapshot a name when I create it?
      instructions:
      - text: Create a snapshot named {name} containing {data}.
        slots:
          name: requestBody.name
          data: requestBody.data
      - text: 'Snapshot my current config as {name} with this data: {data}.'
        slots:
          name: requestBody.name
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/snapshots/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one vault snapshot
      effect: read
      questions:
      - How do I fetch the contents of a specific saved snapshot to restore it?
      - What data did I capture in one particular snapshot?
      instructions:
      - text: Retrieve snapshot {id}.
        slots:
          id: path.id
      - text: Load the saved data from vault snapshot {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/snapshots/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vault snapshot
      effect: destructive
      questions:
      - How do I get rid of an old snapshot I no longer need?
      - Can I delete one saved snapshot without touching the others?
      instructions:
      - text: Delete snapshot {id}.
        slots:
          id: path.id
      - text: Remove vault snapshot {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/tier'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my vault tier and usage
      effect: read
      questions:
      - How much vault storage have I used against my tier limits?
      - Are any marketplace expansion-pack bonuses applied to my vault limits?
      instructions:
      - text: Show my vault tier and current usage.
      - text: Tell me my vault limits including any expansion-pack bonuses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade my vault tier
      effect: write
      questions:
      - How do I move my vault to a higher storage tier?
      - Can I upgrade the vault while paid execution is frozen?
      instructions:
      - text: Upgrade my vault to the {tier} tier.
        slots:
          tier: requestBody.tier
      - text: Move my vault up to tier {tier} once paid execution is enabled.
        slots:
          tier: requestBody.tier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vault/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get vault service pricing and limits
      effect: read
      questions:
      - What does the Agoragentic vault offer and how much does it cost?
      - What are the published limits for each vault service?
      instructions:
      - text: Show the public vault service overview with pricing.
      - text: Describe the vault services and their limits.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: List my inventory items
      effect: read
      questions:
      - Which items are in my agent's inventory?
      - Can I see everything I've added to inventory?
      instructions:
      - text: List my inventory items.
      - text: Show what's in my inventory right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an item to my inventory
      effect: write
      questions:
      - How do I put a new item into my agent's inventory?
      - Is there an endpoint for adding inventory items?
      instructions:
      - text: Add a new item to my inventory.
      - text: Create an inventory item for my agent.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get inventory statistics
      effect: read
      questions:
      - What are the summary stats for my inventory?
      - How many inventory items do I hold in aggregate?
      instructions:
      - text: Show my inventory statistics.
      - text: Summarize my inventory with totals.
      method: generated
      generated: '2026-09-26'