# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Endpoint Agents API
  version: 1.0.0
extends: openapi/thousandeyes-endpoint-agents-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['/endpoint/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoint agents
      effect: read
      questions:
      - Which endpoint agents are installed in my account group?
      - Can I look up endpoint agents by computer name?
      - Is there a way to include deleted endpoint agents in the list?
      instructions:
      - text: List all my endpoint agents.
      - text: Find endpoint agents on computer {computerName}.
        slots:
          computerName: query.computerName
      - text: List endpoint agents named {agentName}.
        slots:
          agentName: query.agentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/{agentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint agent's details
      effect: read
      questions:
      - What details are recorded for a single endpoint agent?
      - Can I look up an endpoint agent even after it was deleted?
      instructions:
      - text: Show endpoint agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Get details for endpoint agent {agentId}, including deleted ones.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/{agentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endpoint agent
      effect: destructive
      questions:
      - Can I remove an endpoint agent from a laptop we've retired?
      - What happens when I delete an endpoint agent?
      instructions:
      - text: Delete endpoint agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Remove endpoint agent {agentId} from account group {aid}.
        slots:
          agentId: path.agentId
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/{agentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or relicense an endpoint agent
      effect: write
      questions:
      - Which endpoint agent fields can be changed after install?
      - Can I switch an endpoint agent's license type?
      instructions:
      - text: Rename endpoint agent {agentId} to {name}.
        slots:
          agentId: path.agentId
          name: requestBody.name
      - text: Change the license type of endpoint agent {agentId} to {licenseType}.
        slots:
          agentId: path.agentId
          licenseType: requestBody.licenseType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search endpoint agents by filters
      effect: read
      questions:
      - Can I search endpoint agents with multiple filter criteria and sorting?
      - What comes back when no endpoint agents match my filters?
      instructions:
      - text: Search endpoint agents matching filters {searchFilters}.
        slots:
          searchFilters: requestBody.searchFilters
      - text: Filter endpoint agents with {searchFilters}, sorted by {searchSort}.
        slots:
          searchFilters: requestBody.searchFilters
          searchSort: requestBody.searchSort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/connection-string'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the endpoint agent connection string
      effect: read
      questions:
      - Where do I get the connection string to register new endpoint agents?
      - Is the endpoint agent connection string different per account group?
      instructions:
      - text: Get the endpoint agent connection string.
      - text: Show the agent connection string for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/{agentId}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable an endpoint agent
      effect: write
      questions:
      - Can I turn a disabled endpoint agent back on?
      - What happens if I enable an endpoint agent that's already enabled?
      instructions:
      - text: Enable endpoint agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Turn endpoint agent {agentId} back on.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/agents/{agentId}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable an endpoint agent
      effect: write
      questions:
      - Can I pause an endpoint agent without deleting it?
      - Is disabling an endpoint agent reversible?
      instructions:
      - text: Disable endpoint agent {agentId}.
        slots:
          agentId: path.agentId
      - text: Pause endpoint agent {agentId} without removing it.
        slots:
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'