Tray.ai · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tray Agent Instances API

6 actions 6 updates phrasing extends openapi/tray-ai-agent-instances-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 6

$.info

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

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

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

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

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

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 Instances API
  version: 1.0.0
extends: openapi/tray-ai-agent-instances-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: 5
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List agents in an on-prem agent group
      effect: read
      questions:
      - Which agent instances are running under one of my on-prem agent groups?
      - Can I paginate the list of agents inside an agent group?
      instructions:
      - text: List every agent in agent group {agent_group} of workspace {workspace}.
        slots:
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      - text: Show the next page of agents in group {agent_group} after cursor {cursor} in workspace {workspace}.
        slots:
          agent_group: path.agent-group-id
          cursor: query.cursor
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an agent instance to an agent group
      effect: write
      questions:
      - How do I register a new on-prem agent under an existing agent group?
      - What name does a new agent instance need when I add it to a group?
      instructions:
      - text: Create an agent named {name} in agent group {agent_group}, workspace {workspace}.
        slots:
          name: requestBody.name
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      - text: Register a new on-prem agent {name} under group {agent_group} in workspace {workspace}.
        slots:
          name: requestBody.name
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one on-prem agent
      effect: read
      questions:
      - What are the details of a specific on-prem agent instance?
      - Is a particular agent in my agent group currently enabled?
      instructions:
      - text: Show agent {agent} from group {agent_group} in workspace {workspace}.
        slots:
          agent: path.agent-id
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      - text: Fetch the details of on-prem agent {agent} (group {agent_group}, workspace {workspace}).
        slots:
          agent: path.agent-id
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an on-prem agent instance
      effect: destructive
      questions:
      - Can I delete a single agent without removing its whole agent group?
      - How do I get rid of an on-prem agent instance I decommissioned?
      instructions:
      - text: Delete agent {agent} from group {agent_group} in workspace {workspace}.
        slots:
          agent: path.agent-id
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      - text: Remove the decommissioned on-prem agent {agent} under group {agent_group}, workspace {workspace}.
        slots:
          agent: path.agent-id
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an on-prem agent
      effect: write
      questions:
      - Can I temporarily switch off an on-prem agent without deleting it?
      - Which setting on an agent instance can I change after creating it?
      instructions:
      - text: Disable agent {agent} in group {agent_group}, workspace {workspace}.
        slots:
          agent: path.agent-id
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      - text: Set enabled to {enabled} for on-prem agent {agent} in group {agent_group} of workspace {workspace}.
        slots:
          enabled: requestBody.enabled
          agent: path.agent-id
          agent_group: path.agent-group-id
          workspace: path.workspace-id
      method: generated
      generated: '2026-09-26'