Agoragentic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS Workspace Board API

13 actions 13 updates phrasing extends openapi/agoragentic-com-agent-os-workspace-board-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 13

$.info
$.paths['/agent-os/workspace-boards/preview'].post
$.paths['/agent-os/workspace-boards'].get
$.paths['/agent-os/workspace-boards'].post
$.paths['/agent-os/workspace-boards/{board_id}'].get
$.paths['/agent-os/workspace-boards/{board_id}/cards'].get
$.paths['/agent-os/workspace-boards/{board_id}/cards'].post
$.paths['/agent-os/workspace-cards/{card_id}'].get
$.paths['/agent-os/workspace-cards/{card_id}/evidence'].get
$.paths['/agent-os/workspace-cards/{card_id}/audit'].get
$.paths['/agent-os/workspace-cards/{card_id}/move'].post
$.paths['/agent-os/workspace-cards/{card_id}/recheck'].post
$.paths['/agent-os/workspace-cards/{card_id}/archive'].post

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 OS Workspace Board API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-os-workspace-board-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: 12
- target: $.paths['/agent-os/workspace-boards/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a workspace board without saving
      effect: read
      questions:
      - Can I see what lanes a new Agent OS workspace board would have before creating it?
      - Does previewing a workspace board change anything?
      instructions:
      - text: Preview a workspace board for workspace {workspace_id} without writing it.
        slots:
          workspace_id: requestBody.workspace_id
      - text: Dry-run a board named {name} to see its evidence lanes.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-boards'].get
  update:
    x-apievangelist-phrasing:
      intent: List my workspace boards
      effect: read
      questions:
      - Which Agent OS workspace boards do I own?
      - Can I list only the boards belonging to one workspace?
      instructions:
      - text: List my workspace boards.
      - text: Show the boards in workspace {workspace_id}.
        slots:
          workspace_id: query.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-boards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace board
      effect: write
      questions:
      - How do I set up a new deployment evidence board for my Agent OS workspace?
      - Does creating a workspace board give it any authority to spend or execute?
      instructions:
      - text: Create a workspace board named {name} in workspace {workspace_id}.
        slots:
          name: requestBody.name
          workspace_id: requestBody.workspace_id
      - text: Save a new board {name} with idempotency key {idempotency_key}.
        slots:
          name: requestBody.name
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-boards/{board_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one workspace board
      effect: read
      questions:
      - How do I open a single workspace board to see its lanes and settings?
      - What does a workspace board record contain?
      instructions:
      - text: Show workspace board {board_id}.
        slots:
          board_id: path.board_id
      - text: Open board {board_id} and describe its lanes.
        slots:
          board_id: path.board_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-boards/{board_id}/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List cards on a workspace board
      effect: read
      questions:
      - What deployment cards are on my workspace board?
      - Can I see only the cards sitting in one lane of a board?
      instructions:
      - text: List the cards on board {board_id}.
        slots:
          board_id: path.board_id
      - text: Show cards in lane {lane_id} of board {board_id}.
        slots:
          lane_id: query.lane_id
          board_id: path.board_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-boards/{board_id}/cards'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a deployment card with evidence
      effect: write
      questions:
      - How do I add a deployment card with its goal and evidence sources to a board?
      - Does adding a card to a board run any proofs or deployments?
      instructions:
      - text: Add card {title} with goal {goal} to board {board_id}.
        slots:
          title: requestBody.title
          goal: requestBody.goal
          board_id: path.board_id
      - text: 'Create a card {title} on board {board_id} for deployment {deployment_id}, goal: {goal}.'
        slots:
          title: requestBody.title
          board_id: path.board_id
          deployment_id: requestBody.deployment_id
          goal: requestBody.goal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-cards/{card_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one workspace card
      effect: read
      questions:
      - How do I look at a single deployment card and which lane it's in?
      - What's stored on a workspace card?
      instructions:
      - text: Show workspace card {card_id}.
        slots:
          card_id: path.card_id
      - text: Tell me the goal and current lane of card {card_id}.
        slots:
          card_id: path.card_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-cards/{card_id}/evidence'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a card's latest evidence bundle
      effect: read
      questions:
      - What evidence currently backs a deployment card?
      - Where can I see the redacted evidence bundle attached to a card?
      instructions:
      - text: Show the latest evidence bundle for card {card_id}.
        slots:
          card_id: path.card_id
      - text: Get the redacted evidence behind workspace card {card_id}.
        slots:
          card_id: path.card_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-cards/{card_id}/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: View a card's audit trail
      effect: read
      questions:
      - Who moved or changed a workspace card, and when?
      - Is there an append-only history of events for each card?
      instructions:
      - text: Show the audit events for card {card_id}.
        slots:
          card_id: path.card_id
      - text: List the history of changes to workspace card {card_id}.
        slots:
          card_id: path.card_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-cards/{card_id}/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a card to another lane
      effect: write
      questions:
      - How do I advance a deployment card to the next lane on the evidence ladder?
      - Why would moving a card to a lane be refused?
      instructions:
      - text: Move card {card_id} to lane {target_lane_id}.
        slots:
          card_id: path.card_id
          target_lane_id: requestBody.target_lane_id
      - text: Advance workspace card {card_id} into {target_lane_id} if its evidence passes.
        slots:
          card_id: path.card_id
          target_lane_id: requestBody.target_lane_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-cards/{card_id}/recheck'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a card's evidence bundle
      effect: write
      questions:
      - How do I re-gather the evidence for a card after something changed?
      - Can I refresh a card's evidence bundle on demand?
      instructions:
      - text: Recheck the evidence for card {card_id}.
        slots:
          card_id: path.card_id
      - text: Rebuild workspace card {card_id}'s evidence bundle now.
        slots:
          card_id: path.card_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspace-cards/{card_id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a workspace card
      effect: destructive
      questions:
      - How do I archive a deployment card I no longer need on the board?
      - Can I clear finished cards off a workspace board?
      instructions:
      - text: Archive card {card_id}.
        slots:
          card_id: path.card_id
      - text: Remove workspace card {card_id} from the board by archiving it.
        slots:
          card_id: path.card_id
      method: generated
      generated: '2026-09-26'