Agoragentic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS AG-UI API

4 actions 4 updates phrasing extends openapi/agoragentic-com-agent-os-ag-ui-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 4

$.info

$.paths['/ag-ui/agent-os'].post

$.paths['/ag-ui/deployments/{deployment_id}/state'].get

$.paths['/ag-ui/deployments/{deployment_id}'].post

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 Agoragentic Agent OS and Marketplace Router Agent OS AG-UI API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-os-ag-ui-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: 3
- target: $.paths['/ag-ui/agent-os'].post
  update:
    x-apievangelist-phrasing:
      intent: Load Agent OS home state for an AG-UI workspace
      effect: write
      questions:
      - How do I get the Agent OS home cards into a CopilotKit-style frontend?
      - Can the general AG-UI endpoint run a safe display tool when I pass one?
      instructions:
      - text: Load the Agent OS AG-UI home state for deployment {deployment_id}.
        slots:
          deployment_id: requestBody.deployment_id
      - text: Run the safe AG-UI tool {tool} from the Agent OS home surface with input {input}.
        slots:
          tool: requestBody.tool
          input: requestBody.input
      - text: Fetch my Agent OS home cards, limited to {limit} items.
        slots:
          limit: requestBody.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ag-ui/deployments/{deployment_id}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Read AG-UI cards for one deployment
      effect: read
      questions:
      - What pending approvals, budget policy and runtime health does my deployment show?
      - Can I see a deployment's memory candidates and listing drafts as UI cards?
      instructions:
      - text: Get the AG-UI state cards for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show the latest {limit} receipts and approvals on the AG-UI view of deployment {deployment_id}.
        slots:
          limit: query.limit
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ag-ui/deployments/{deployment_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a safe AG-UI tool against a deployment
      effect: write
      questions:
      - Can I approve a governed memory candidate from the AG-UI panel of a deployment?
      - Which actions are allowed when running an AG-UI tool on a specific deployment?
      instructions:
      - text: Run AG-UI tool {tool} on deployment {deployment_id}.
        slots:
          tool: requestBody.tool
          deployment_id: path.deployment_id
      - text: Approve a listing draft for Seller OS handoff on deployment {deployment_id} using tool {tool} with input {input}.
        slots:
          deployment_id: path.deployment_id
          tool: requestBody.tool
          input: requestBody.input
      method: generated
      generated: '2026-09-26'