Agoragentic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS Work Packs API

16 actions 16 updates phrasing extends openapi/agoragentic-com-agent-os-work-packs-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 16

$.info
$.paths['/agent-os/templates'].get
$.paths['/agent-os/templates/{id}'].get
$.paths['/agent-os/build/preview'].post
$.paths['/agent-os/templates/{id}/preview'].post
$.paths['/agent-os/templates/{id}/deploy'].post
$.paths['/agent-os/deployments/{deployment_id}/work-pack'].get
$.paths['/agent-os/deployments/{deployment_id}/work-pack/pause'].post
$.paths['/agent-os/deployments/{deployment_id}/work-pack/resume'].post
$.paths['/agent-os/deployments/{deployment_id}/work-pack/receipts'].get
$.paths['/agent-os/workflow-packages/preview'].post
$.paths['/agent-os/workflow-packages'].get
$.paths['/agent-os/workflow-packages'].post
$.paths['/agent-os/workflow-packages/{package_id}'].get
$.paths['/agent-os/workflow-packages/{package_id}/canary'].post
$.paths['/agent-os/workflow-packages/{package_id}/exposure'].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 Work Packs API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-os-work-packs-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: 15
- target: $.paths['/agent-os/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse Agent OS Work Pack templates
      effect: read
      questions:
      - What packaged Work Pack templates can I start an agent from?
      - Which Work Packs come with budget and approval defaults already set?
      instructions:
      - text: List all Agent OS Work Pack templates.
      - text: Show me the starter Work Packs available for onboarding.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one Work Pack template
      effect: read
      questions:
      - What's in a specific Work Pack template's manifest?
      - Who is a particular Work Pack template meant for?
      instructions:
      - text: Show Work Pack template {id}.
        slots:
          id: path.id
      - text: Get the schedule and budget defaults for template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/build/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a custom governed agent build
      effect: read
      questions:
      - Can I sketch a custom recurring agent workflow and see its launch plan without spending?
      - What budget and approval policy would a custom agent build get?
      instructions:
      - text: Preview a custom agent named {name} whose goal is {goal}.
        slots:
          name: requestBody.name
          goal: requestBody.goal
      - text: Draft a governed build for {workflow} running {cadence} with a daily cap of {max_daily_spend_usdc} USDC.
        slots:
          workflow: requestBody.workflow
          cadence: requestBody.cadence
          max_daily_spend_usdc: requestBody.max_daily_spend_usdc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/templates/{id}/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview deploying a Work Pack template
      effect: read
      questions:
      - Can I see what deploying a Work Pack would create before committing?
      - Does previewing a Work Pack deployment trigger any spend or scheduling?
      instructions:
      - text: Preview deploying Work Pack template {id}.
        slots:
          id: path.id
      - text: Preview template {id} as {name} on schedule {schedule}.
        slots:
          id: path.id
          name: requestBody.name
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/templates/{id}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a Work Pack template
      effect: write
      questions:
      - How do I turn a Work Pack template into an actual deployment?
      - Does deploying a Work Pack start the scheduler or spend money?
      instructions:
      - text: Deploy Work Pack template {id}.
        slots:
          id: path.id
      - text: Deploy template {id} named {name} with goal {goal} and budget policy {budget_policy}.
        slots:
          id: path.id
          name: requestBody.name
          goal: requestBody.goal
          budget_policy: requestBody.budget_policy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/deployments/{deployment_id}/work-pack'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a Work Pack deployment
      effect: read
      questions:
      - What is the lifecycle state of my Work Pack deployment?
      - Can I look up the first-proof plan for a deployed Work Pack?
      instructions:
      - text: Show Work Pack deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Get the lifecycle and schedule intent for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/deployments/{deployment_id}/work-pack/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a Work Pack deployment
      effect: write
      questions:
      - Can I pause a Work Pack I deployed?
      - What happens to a Work Pack's lifecycle when it's paused?
      instructions:
      - text: Pause Work Pack deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Put the Work Pack on {deployment_id} on hold.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/deployments/{deployment_id}/work-pack/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused Work Pack
      effect: write
      questions:
      - How do I restart a Work Pack I paused earlier?
      - Does resuming a Work Pack turn scheduler dispatch back on?
      instructions:
      - text: Resume Work Pack deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Unpause the Work Pack on {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/deployments/{deployment_id}/work-pack/receipts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Work Pack's receipt links
      effect: read
      questions:
      - Where are the proof and receipt links for a Work Pack deployment?
      - Are Work Pack receipts the authoritative payment records?
      instructions:
      - text: List receipt links for Work Pack deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show the last {limit} proof receipts for deployment {deployment_id}.
        slots:
          limit: query.limit
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workflow-packages/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview packaging a workflow as a service
      effect: read
      questions:
      - Can I see what my repeatable workflow would look like as a paid service before saving it?
      - Does previewing a workflow package create an x402 route?
      instructions:
      - text: 'Preview packaging workflow {name}: {workflow_summary}.'
        slots:
          name: requestBody.name
          workflow_summary: requestBody.workflow_summary
      - text: Preview a service draft for {name} priced at {price_usdc} USDC.
        slots:
          name: requestBody.name
          price_usdc: requestBody.price_usdc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workflow-packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List my workflow package drafts
      effect: read
      questions:
      - Which workflow package drafts do I own?
      - What canary status do my workflow packages have?
      instructions:
      - text: List my workflow package drafts.
      - text: Show up to {limit} of my workflow packages with their service-page state.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workflow-packages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workflow package service draft
      effect: write
      questions:
      - How do I save a repeatable workflow as a governed service draft?
      - Does creating a workflow package publish a public listing?
      instructions:
      - text: Create a workflow package named {name} for {workflow_summary}.
        slots:
          name: requestBody.name
          workflow_summary: requestBody.workflow_summary
      - text: Save workflow package {name} at {price_usdc} USDC calling {endpoint_url}.
        slots:
          name: requestBody.name
          price_usdc: requestBody.price_usdc
          endpoint_url: requestBody.endpoint_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workflow-packages/{package_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one workflow package
      effect: read
      questions:
      - What lifecycle events has a specific workflow package gone through?
      - Can I see the proof receipt links for one workflow package?
      instructions:
      - text: Show workflow package {package_id}.
        slots:
          package_id: path.package_id
      - text: Get recent events and receipts for package {package_id}.
        slots:
          package_id: path.package_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workflow-packages/{package_id}/canary'].post
  update:
    x-apievangelist-phrasing:
      intent: Record canary proof for a workflow package
      effect: write
      questions:
      - How do I record that a manual test run of my workflow package passed?
      - Can I attach sample input and output as canary evidence?
      instructions:
      - text: Record a canary for package {package_id} with passed set to {passed}.
        slots:
          package_id: path.package_id
          passed: requestBody.passed
      - text: Log canary proof on {package_id} with input {input_sample} and output {output_sample}.
        slots:
          package_id: path.package_id
          input_sample: requestBody.input_sample
          output_sample: requestBody.output_sample
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workflow-packages/{package_id}/exposure'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a workflow package's exposure mode
      effect: write
      questions:
      - Once canary proof passes, how do I approve how my workflow package is exposed?
      - Does approving exposure publish the workflow package listing?
      instructions:
      - text: Approve exposure for workflow package {package_id}.
        slots:
          package_id: path.package_id
      - text: Set package {package_id}'s exposure mode to {exposure_mode}.
        slots:
          package_id: path.package_id
          exposure_mode: requestBody.exposure_mode
      method: generated
      generated: '2026-09-26'