API Evangelist conversational phrasing for TextQL Agent Service API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Agent Service API
  version: 1.0.0
extends: openapi/textql-agentservice-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: 13
- target: $.paths['/textql.rpc.public.agent.AgentService/CreateAgent'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent
      effect: write
      questions:
      - How do I set up a new TextQL agent with its own prompt?
      - Can an agent post to a chat channel on a recurring schedule?
      - Which LLM model can a new agent use?
      instructions:
      - text: Create an agent named {name} with prompt {prompt}.
        slots:
          name: requestBody.name
          prompt: requestBody.prompt
      - text: Create agent {name} that posts to channel {slack_channel_id} on cron {posting_frequency_crons}.
        slots:
          name: requestBody.name
          slack_channel_id: requestBody.slackChannelId
          posting_frequency_crons: requestBody.postingFrequencyCrons
      - text: Set up agent {name} running on model {llm_model}.
        slots:
          name: requestBody.name
          llm_model: requestBody.llmModel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/DeleteAgent'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent
      effect: destructive
      questions:
      - How do I remove an agent permanently?
      - Can a deleted agent be brought back?
      instructions:
      - text: Delete agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      - text: Permanently remove the agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/DuplicateAgent'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate an agent
      effect: write
      questions:
      - Can I clone an existing agent with its configuration?
      - Is copying an agent faster than rebuilding it?
      instructions:
      - text: Duplicate agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      - text: Make a copy of the agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/GetAgent'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an agent's configuration
      effect: read
      questions:
      - What prompt and schedule is an agent configured with?
      - Can I look up one agent by its ID?
      instructions:
      - text: Get agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      - text: Show the settings of agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/GetAgentDBSchema'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the schema of an agent's database
      effect: read
      questions:
      - What tables does a stateful agent keep in its own database?
      - Can I inspect the schema of an agent's storage?
      instructions:
      - text: Show the database schema for agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      - text: List the tables and columns agent {agent_id} stores.
        slots:
          agent_id: requestBody.agentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/GetAgentDBTablePreview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview rows in an agent's database table
      effect: read
      questions:
      - Can I peek at the rows an agent has saved in a table?
      - Is there a limit on how many preview rows come back?
      instructions:
      - text: Preview table {table_name} in agent {agent_id}'s database.
        slots:
          table_name: requestBody.tableName
          agent_id: requestBody.agentId
      - text: Show {limit} rows from agent {agent_id} table {table_name}.
        slots:
          limit: requestBody.limit
          agent_id: requestBody.agentId
          table_name: requestBody.tableName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/GetAgentRun'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a single agent run
      effect: read
      questions:
      - What happened during a particular agent run?
      - Can I check the outcome of one run by ID?
      instructions:
      - text: Get agent run {run_id}.
        slots:
          run_id: requestBody.runId
      - text: Show the result of run {run_id}.
        slots:
          run_id: requestBody.runId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/ListAgentRuns'].post
  update:
    x-apievangelist-phrasing:
      intent: List an agent's runs
      effect: read
      questions:
      - When has my agent run, and did those runs succeed?
      - Can I filter an agent's runs by trigger source or status?
      instructions:
      - text: List runs for agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      - text: Show agent {agent_id} runs with status {status} triggered by {trigger_source}.
        slots:
          agent_id: requestBody.agentId
          status: requestBody.status
          trigger_source: requestBody.triggerSource
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/ListAgents'].post
  update:
    x-apievangelist-phrasing:
      intent: List agents
      effect: read
      questions:
      - Which agents exist in my workspace?
      - Can I include inactive agents or every agent across the org?
      instructions:
      - text: List my agents.
      - text: List all agents in the org, including inactive ones, active within {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/ResetAgentAvatar'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an agent's avatar
      effect: write
      questions:
      - Can I go back to the default avatar for an agent?
      - How do I remove a custom agent picture?
      instructions:
      - text: Reset the avatar of agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      - text: Restore the default picture on agent {agent_id}.
        slots:
          agent_id: requestBody.agentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/TriggerAgent'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an agent run now
      effect: write
      questions:
      - Can I run an agent right away instead of waiting for its schedule?
      - How do I manually kick off an agent?
      instructions:
      - text: Trigger agent {agent_id} now.
        slots:
          agent_id: requestBody.agentId
      - text: Run the agent {agent_id} on demand.
        slots:
          agent_id: requestBody.agentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/UpdateAgent'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an agent
      effect: write
      questions:
      - Can I change an existing agent's prompt or pause it?
      - Which people or roles can invoke my agent as a subagent?
      - How do I change where an agent posts its updates?
      instructions:
      - text: Update agent {agent_id}'s prompt to {prompt}.
        slots:
          agent_id: requestBody.agentId
          prompt: requestBody.prompt
      - text: Deactivate agent {agent_id} by setting active to {is_active}.
        slots:
          agent_id: requestBody.agentId
          is_active: requestBody.isActive
      - text: Move agent {agent_id}'s posts to Teams channel {teams_channel_id}.
        slots:
          agent_id: requestBody.agentId
          teams_channel_id: requestBody.teamsChannelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.agent.AgentService/UploadAgentAvatar'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a custom avatar for an agent
      effect: write
      questions:
      - Can I give an agent its own profile picture?
      - What image data does an agent avatar upload need?
      instructions:
      - text: Upload {file_name} as the avatar for agent {agent_id}.
        slots:
          file_name: requestBody.fileName
          agent_id: requestBody.agentId
      - text: Set agent {agent_id}'s picture from image data {image_data}.
        slots:
          agent_id: requestBody.agentId
          image_data: requestBody.imageData
      method: generated
      generated: '2026-10-01'