Tray.ai · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tray Agent Groups API

4 actions 4 updates phrasing extends openapi/tray-ai-agent-groups-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Tray.ai's API. It is a proposal applied on top of the contract, not a document Tray.ai publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups'].get

$.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups'].post

$.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tray Agent Groups API
  version: 1.0.0
extends: openapi/tray-ai-agent-groups-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: 3
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List on-prem agent groups in a workspace
      effect: read
      questions:
      - Which on-prem agent groups exist in my Tray.ai workspace?
      - Can I page through a workspace's agent groups with a cursor?
      instructions:
      - text: List the on-prem agent groups in workspace {workspace}.
        slots:
          workspace: path.workspace-id
      - text: Show the first {count} agent groups in workspace {workspace}.
        slots:
          count: query.first
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an on-prem agent group
      effect: write
      questions:
      - How do I set up a new group for on-prem agents in a workspace?
      - What do I need to name a new agent group before adding agents to it?
      instructions:
      - text: Create an on-prem agent group called {name} in workspace {workspace}.
        slots:
          name: requestBody.name
          workspace: path.workspace-id
      - text: Add a new agent group named {name} to my workspace {workspace}.
        slots:
          name: requestBody.name
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an on-prem agent group
      effect: destructive
      questions:
      - Can I remove an on-prem agent group I no longer use?
      - What happens when I delete an agent group from a workspace?
      instructions:
      - text: Delete agent group {agent_group} from workspace {workspace}.
        slots:
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      - text: Remove the on-prem agent group {agent_group} in workspace {workspace}.
        slots:
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'