# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Anthropic Deployments API
  version: 1.0.0
extends: openapi/anthropic-deployments-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: 8
- target: $.paths['/v1/deployments/{deployment_id}/archive?beta=true'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive an agent deployment
      effect: write
      questions:
      - How do I archive a deployment I don't need anymore?
      - Can archived deployments still show up if I ask for them?
      instructions:
      - text: Archive deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Retire deployment {deployment_id} into the archive.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments/{deployment_id}/pause?beta=true'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a scheduled deployment
      effect: write
      questions:
      - How do I temporarily stop a deployment from running on its schedule?
      - Can I pause a deployment and resume it later?
      instructions:
      - text: Pause deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Hold off scheduled runs of deployment {deployment_id} for now.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments/{deployment_id}/run?beta=true'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a deployment run immediately
      effect: write
      questions:
      - Can I kick off a deployment right away instead of waiting for its schedule?
      - What's the way to trigger a one-off run of a deployment?
      instructions:
      - text: Run deployment {deployment_id} now.
        slots:
          deployment_id: path.deployment_id
      - text: Trigger an immediate run of deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments/{deployment_id}/unpause?beta=true'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused deployment
      effect: write
      questions:
      - How do I restart a deployment I paused earlier?
      - Will unpausing put a deployment back on its schedule?
      instructions:
      - text: Unpause deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Resume the schedule for paused deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments/{deployment_id}?beta=true'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's configuration
      effect: read
      questions:
      - What agent, environment and schedule does a deployment use?
      - Can I check whether a deployment is paused?
      instructions:
      - text: Get deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show the schedule and status of deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments/{deployment_id}?beta=true'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a deployment's schedule, agent or budget
      effect: write
      questions:
      - How do I change when a deployment runs?
      - Can I point an existing deployment at a different agent or environment?
      - Is it possible to set a spending budget on a deployment after creating it?
      instructions:
      - text: Change deployment {deployment_id} schedule to {schedule}.
        slots:
          deployment_id: path.deployment_id
          schedule: requestBody.schedule
      - text: Switch deployment {deployment_id} to agent {agent} in environment {environment_id}.
        slots:
          deployment_id: path.deployment_id
          agent: requestBody.agent
          environment_id: requestBody.environment_id
      - text: Set the budget on deployment {deployment_id} to {budget}.
        slots:
          deployment_id: path.deployment_id
          budget: requestBody.budget
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments?beta=true'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments by agent or status
      effect: read
      questions:
      - Which deployments are set up for a given agent?
      - Can I filter deployments by status or creation date, including archived ones?
      instructions:
      - text: List deployments for agent {agent_id}.
        slots:
          agent_id: query.agent_id
      - text: Show deployments with status {status} created since {since}.
        slots:
          status: query.status
          since: query.created_at[gte]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/deployments?beta=true'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled agent deployment
      effect: write
      questions:
      - How do I set up an agent to run on a schedule?
      - What do I need to provide to create a deployment, such as initial events and an environment?
      instructions:
      - text: Create deployment {name} running agent {agent} in environment {environment_id} starting with {initial_events}.
        slots:
          name: requestBody.name
          agent: requestBody.agent
          environment_id: requestBody.environment_id
          initial_events: requestBody.initial_events
      - text: Deploy agent {agent} as {name} in {environment_id} on schedule {schedule} with first events {initial_events}.
        slots:
          agent: requestBody.agent
          name: requestBody.name
          environment_id: requestBody.environment_id
          schedule: requestBody.schedule
          initial_events: requestBody.initial_events
      method: generated
      generated: '2026-09-26'