# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Textql.rpc.platform.Playbook Service API
  version: 1.0.0
extends: openapi/textql-textql-rpc-platform-playbookservice-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['/v1/playbooks/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a playbook via the platform API
      effect: write
      questions:
      - How do I create a playbook through the v1 platform endpoint?
      - Can I start an empty playbook programmatically?
      instructions:
      - text: Create a new playbook through the platform API.
      - text: Create a blank playbook, waiting up to {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/playbooks/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a playbook
      effect: destructive
      questions:
      - How do I delete a playbook using the platform API?
      - Is a deleted playbook gone for good?
      instructions:
      - text: Delete playbook {playbook_id}.
        slots:
          playbook_id: requestBody.playbookId
      - text: Permanently remove playbook {playbook_id}.
        slots:
          playbook_id: requestBody.playbookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/playbooks/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a playbook
      effect: write
      questions:
      - How do I take a playbook live from the platform API?
      - What makes a draft playbook start running?
      instructions:
      - text: Deploy playbook {playbook_id}.
        slots:
          playbook_id: requestBody.playbookId
      - text: Put playbook {playbook_id} into production.
        slots:
          playbook_id: requestBody.playbookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/playbooks/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a playbook's details
      effect: read
      questions:
      - What's configured on one playbook?
      - Can I page through a playbook's entries?
      instructions:
      - text: Get playbook {playbook_id}.
        slots:
          playbook_id: requestBody.playbookId
      - text: Fetch playbook {playbook_id} with {limit} entries from offset {offset}.
        slots:
          playbook_id: requestBody.playbookId
          limit: requestBody.limit
          offset: requestBody.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/playbooks/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List and search playbooks
      effect: read
      questions:
      - Which playbooks exist in my organization?
      - Can I search playbooks by name and filter by status?
      instructions:
      - text: List my playbooks.
      - text: Search playbooks for {search_term} with status {status_filter}.
        slots:
          search_term: requestBody.searchTerm
          status_filter: requestBody.statusFilter
      - text: List playbooks created by member {creator_member_id}.
        slots:
          creator_member_id: requestBody.creatorMemberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/playbooks/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a playbook now
      effect: write
      questions:
      - Can I trigger a playbook on demand?
      - Is a dry run possible before a real playbook run?
      instructions:
      - text: Run playbook {playbook_id} now.
        slots:
          playbook_id: requestBody.playbookId
      - text: Dry-run playbook {playbook_id} with template {template_id}.
        slots:
          playbook_id: requestBody.playbookId
          template_id: requestBody.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/playbooks/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a playbook
      effect: write
      questions:
      - Can I change a playbook's prompt, schedule or model?
      - How do I change where a playbook's reports are emailed?
      instructions:
      - text: Set playbook {playbook_id}'s prompt to {prompt}.
        slots:
          playbook_id: requestBody.playbookId
          prompt: requestBody.prompt
      - text: Run playbook {playbook_id} on cron {cron_string}.
        slots:
          playbook_id: requestBody.playbookId
          cron_string: requestBody.cronString
      - text: Email playbook {playbook_id}'s reports to {email_addresses}.
        slots:
          playbook_id: requestBody.playbookId
          email_addresses: requestBody.emailAddresses
      method: generated
      generated: '2026-10-01'