# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for llm-api Agent Schedule API
  version: 1.0.0
extends: openapi/treasure-data-agentschedule-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/agent_schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent schedules
      effect: read
      questions:
      - Which agents are set to run on a schedule?
      - Can I list schedules for just one agent or one project?
      instructions:
      - text: List all agent schedules.
      - text: List schedules for agent {agentId}.
        slots:
          agentId: query.filter[agentId]
      - text: List agent schedules in project {projectId} sorted by {sort}.
        slots:
          projectId: query.filter[projectId]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agent_schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an agent
      effect: write
      questions:
      - Can I make an agent run automatically on a schedule?
      - What does a new agent schedule need?
      instructions:
      - text: Create an agent schedule with {data}.
        slots:
          data: requestBody.data
      - text: Schedule an agent run using payload {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agent_schedules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent schedule
      effect: read
      questions:
      - When does a particular agent schedule run next, and what does it run?
      - Can I fetch one agent schedule with its related records?
      instructions:
      - text: Show agent schedule {id}.
        slots:
          id: path.id
      - text: Get agent schedule {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agent_schedules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent schedule
      effect: destructive
      questions:
      - Can I stop an agent from running on its schedule for good?
      - What removes a scheduled agent run?
      instructions:
      - text: Delete agent schedule {id}.
        slots:
          id: path.id
      - text: Remove the schedule {id} so the agent stops running automatically.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agent_schedules/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an agent schedule
      effect: write
      questions:
      - Can I change when a scheduled agent runs?
      - Which settings of an agent schedule can I edit?
      instructions:
      - text: Update agent schedule {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change the timing of agent schedule {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agent_schedules/{id}/callback'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a scheduled agent run's result
      effect: write
      questions:
      - How does a workflow report back that a scheduled agent run finished or failed?
      - Can I record an error message for a failed scheduled agent attempt?
      instructions:
      - text: Report status {status} for schedule {id}, session {session_id}, attempt {attempt_id}.
        slots:
          status: requestBody.status
          id: path.id
          session_id: requestBody.session_id
          attempt_id: requestBody.attempt_id
      - text: Mark schedule {id} attempt {attempt_id} in session {session_id} as {status} with error {error_message}.
        slots:
          id: path.id
          attempt_id: requestBody.attempt_id
          session_id: requestBody.session_id
          status: requestBody.status
          error_message: requestBody.error_message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agent_schedules/{id}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Execute an agent schedule now
      effect: write
      questions:
      - Can I run a scheduled agent right away instead of waiting?
      - Is there a way to get the workflow YAML an agent schedule would run?
      instructions:
      - text: Execute agent schedule {id} now.
        slots:
          id: path.id
      - text: Run schedule {id} and return its workflow YAML.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'