Tray.ai

Tray.ai Agent Instances API

{'$ref': 'descriptions/trayapi/tags/agent-instances.md'}

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents List agents in an on-prem agent group · List Agents #
Ask an LLM
“Which agent instances are running under one of my on-prem agent groups?”
“Can I paginate the list of agents inside an agent group?”
Tell an agent
List every agent in agent group {agent_group} of workspace {workspace}.
Show the next page of agents in group {agent_group} after cursor {cursor} in workspace {workspace}.
POST /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents Add an agent instance to an agent group · Create Agent #
Ask an LLM
“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?”
Tell an agent
Create an agent named {name} in agent group {agent_group}, workspace {workspace}.
Register a new on-prem agent {name} under group {agent_group} in workspace {workspace}.
GET /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id} Get details of one on-prem agent · Retrieve Agent #
Ask an LLM
“What are the details of a specific on-prem agent instance?”
“Is a particular agent in my agent group currently enabled?”
Tell an agent
Show agent {agent} from group {agent_group} in workspace {workspace}.
Fetch the details of on-prem agent {agent} (group {agent_group}, workspace {workspace}).
PATCH /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id} Enable or disable an on-prem agent · Update Agent #
Ask an LLM
“Can I temporarily switch off an on-prem agent without deleting it?”
“Which setting on an agent instance can I change after creating it?”
Tell an agent
Disable agent {agent} in group {agent_group}, workspace {workspace}.
Set enabled to {enabled} for on-prem agent {agent} in group {agent_group} of workspace {workspace}.
DELETE /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id} Delete an on-prem agent instance · Delete Agent #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete agent {agent} from group {agent_group} in workspace {workspace}.
Remove the decommissioned on-prem agent {agent} under group {agent_group}, workspace {workspace}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/tray-ai/openapi/tray-ai-agent-instances-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/tray-ai/json-schema/tray-ai-public-on-prem-agent-instance-http-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/tray-ai/json-schema/tray-ai-base-page-public-on-prem-agent-instance-http-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/tray-ai/json-schema/tray-ai-public-create-on-prem-agent-instance-http-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/tray-ai/json-schema/tray-ai-public-create-on-prem-agent-instance-http-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/tray-ai/json-schema/tray-ai-public-update-on-prem-agent-instance-http-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tray-ai:tray-ai-agent-instances-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tray-ai-agent-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tray Agent Instances API
  version: 1.0.0
  x-logo:
    url: ../images/tray-dev-logo.svg
    altText: Tray.ai logo
  description:
    $ref: descriptions/trayapi/tags/agent-instances.md
servers:
- url: https://api.tray.io
  description: US
- url: https://api.eu1.tray.io
  description: EU
- url: https://api.ap1.tray.io
  description: APAC
security:
- bearerAuth: []
tags:
- name: agent-instances
  x-displayName: Agent Instances
  description:
    $ref: descriptions/trayapi/tags/agent-instances.md
paths:
  /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents:
    get:
      operationId: getCoreV1WorkspacesWorkspace-idOn-prem-agent-groupsAgent-group-idAgents
      summary: List Agents
      description: Returns paginated list of agent instances from an agent group using `agent-group-id` and `workspace-id`
      tags:
      - agent-instances
      parameters:
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-group-id
        in: path
        required: true
        schema:
          type: string
      - name: first
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: last
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasePage_PublicOnPremAgentInstanceHttpResponse'
        '400':
          description: Invalid Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Timeout'
        '409':
          description: Concurrency Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrencyConflict'
        '413':
          description: Content Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentTooLarge'
        '429':
          description: Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceeded'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
    post:
      operationId: postCoreV1WorkspacesWorkspace-idOn-prem-agent-groupsAgent-group-idAgents
      summary: Create Agent
      description: Adds an agent instance under an agent group using `agent-group-id` and `workspace-id`
      tags:
      - agent-instances
      parameters:
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-group-id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCreateOnPremAgentInstanceHttpRequest'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCreateOnPremAgentInstanceHttpResponse'
        '400':
          description: Invalid Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Timeout'
        '409':
          description: Concurrency Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrencyConflict'
        '413':
          description: Content Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentTooLarge'
        '429':
          description: Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceeded'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
  /core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}:
    get:
      operationId: getCoreV1WorkspacesWorkspace-idOn-prem-agent-groupsAgent-group-idAgentsAgent-id
      summary: Retrieve Agent
      description: Get details of an agent instance using `agent-id`
      tags:
      - agent-instances
      parameters:
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-group-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicOnPremAgentInstanceHttpResponse'
        '400':
          description: Invalid Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Timeout'
        '409':
          description: Concurrency Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrencyConflict'
        '413':
          description: Content Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentTooLarge'
        '429':
          description: Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceeded'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
    patch:
      operationId: patchCoreV1WorkspacesWorkspace-idOn-prem-agent-groupsAgent-group-idAgentsAgent-id
      summary: Update Agent
      description: Updates an agent instance using `agent-id`
      tags:
      - agent-instances
      parameters:
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-group-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicUpdateOnPremAgentInstanceHttpRequest'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicOnPremAgentInstanceHttpResponse'
        '400':
          description: Invalid Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Timeout'
        '409':
          description: Concurrency Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrencyConflict'
        '413':
          description: Content Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentTooLarge'
        '429':
          description: Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceeded'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
    delete:
      operationId: deleteCoreV1WorkspacesWorkspace-idOn-prem-agent-groupsAgent-group-idAgentsAgent-id
      summary: Delete Agent
      description: Delete an agent instance using `agent-id`
      tags:
      - agent-instances
      parameters:
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-group-id
        in: path
        required: true
        schema:
          type: string
      - name: agent-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '400':
          description: Invalid Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Timeout'
        '409':
          description: Concurrency Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrencyConflict'
        '413':
          description: Content Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentTooLarge'
        '429':
          description: Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceeded'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
components:
  schemas:
    PublicCreateOnPremAgentInstanceHttpResponse:
      title: PublicCreateOnPremAgentInstanceHttpResponse
      type: object
      required:
      - id
      - agentGroupId
      - name
      - registrationToken
      properties:
        id:
          type: string
        agentGroupId:
          type: string
        name:
          type: string
        registrationToken:
          type: string
    PublicUpdateOnPremAgentInstanceHttpRequest:
      title: PublicUpdateOnPremAgentInstanceHttpRequest
      type: object
      properties:
        enabled:
          type: boolean
    ResourceNotFound:
      title: ResourceNotFound
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    ContentTooLarge:
      title: ContentTooLarge
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    BasePageInfo_PublicOnPremAgentInstanceHttpResponse:
      title: BasePageInfo_PublicOnPremAgentInstanceHttpResponse
      type: object
      properties:
        startCursor:
          type: string
        endCursor:
          type: string
        hasNextPage:
          type: boolean
        hasPreviousPage:
          type: boolean
    InvalidInput:
      title: InvalidInput
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    InternalError:
      title: InternalError
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    PublicOnPremAgentInstanceHttpResponse:
      title: PublicOnPremAgentInstanceHttpResponse
      type: object
      required:
      - id
      - agentGroupId
      - name
      - registered
      - connected
      - enabled
      properties:
        id:
          type: string
        agentGroupId:
          type: string
        name:
          type: string
        registered:
          type: boolean
        connected:
          type: boolean
        enabled:
          type: boolean
    LimitExceeded:
      title: LimitExceeded
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    Timeout:
      title: Timeout
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    BasePage_PublicOnPremAgentInstanceHttpResponse:
      title: BasePage_PublicOnPremAgentInstanceHttpResponse
      type: object
      required:
      - pageInfo
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/PublicOnPremAgentInstanceHttpResponse'
        pageInfo:
          $ref: '#/components/schemas/BasePageInfo_PublicOnPremAgentInstanceHttpResponse'
    Unauthorized:
      title: Unauthorized
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    Forbidden:
      title: Forbidden
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    ConcurrencyConflict:
      title: ConcurrencyConflict
      type: object
      required:
      - message
      properties:
        message:
          type: string
        code:
          type: string
    PublicCreateOnPremAgentInstanceHttpRequest:
      title: PublicCreateOnPremAgentInstanceHttpRequest
      type: object
      required:
      - name
      properties:
        name:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: Introduction
  tags:
  - overview
  - authentication
  - regionality
  - collection
  - rate-limits
- name: Core
  tags:
  - authentications
  - connectors
  - triggers
  - workspaces
  - users
  - projects
  - solutions
- name: CDK
  tags:
  - deployments
  - permissions
- name: On Premise
  tags:
  - agent-groups
  - agent-instances
x-provenance:
  method: harvested
  publisher: Tray.ai
  source: https://tray.ai/documentation/files/openapi/trayapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)