GET
/
v1
/
orchestrate
/
agents
/
environment
/
{environment_name}
/
releases
List Versioned Agents By Environment Name
curl --request GET \
  --url http://{api_endpoint}/api/v1/v1/orchestrate/agents/environment/{environment_name}/releases \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "version_label": 123,
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "llm": "<string>",
    "style": "default",
    "supported_apps": [
      "slack/askhr"
    ],
    "points_to": [],
    "comments": "<string>",
    "mapped_environments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "current_version": 123
      }
    ],
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_by": "<string>",
    "hidden": false,
    "environments": [],
    "deleted_at": "2023-11-07T05:31:56Z",
    "knowledge_base": [
      "<string>"
    ],
    "display_name": "<string>",
    "structured_output": {},
    "guidelines": [],
    "custom_join_tool": {},
    "tags": [
      "<string>"
    ],
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deployment_status": "<string>",
    "chat_with_docs": {
      "enabled": false,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "",
        "max_docs_passed_to_llm": 5,
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'm afraid I don't understand. Please rephrase your question.",
        "enabled": true
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      }
    },
    "additional_properties": {
      "starter_prompts": {
        "customize": [
          {
            "id": "<string>",
            "title": "<string>",
            "subtitle": "<string>",
            "prompt": "<string>",
            "state": "<string>"
          }
        ]
      },
      "welcome_content": {
        "welcome_message": "<string>",
        "description": "<string>"
      }
    },
    "context_access_enabled": true,
    "context_variables": []
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environment_name
string
required

Query Parameters

include_hidden
boolean
default:false

Response

Successful Response

id
string<uuid>
required

Unique identifier for the agent

tenant_id
string
required

ID of the tenant that owns this agent

name
string
required

Name of the agent

description
string
required

Description of what the agent does

version_label
integer
required

Version of the deployed agent

style
enum<string>
required

Style of the agent

Available options:
default,
react,
planner
created_by
string
required

ID of the user who created the agent

created_on
string<date-time>
required

Creation timestamp

updated_by
string
required

ID of the user who updated the agent

updated_at
string<date-time>
required

Last update timestamp

instructions
string | null

Instructions for the agent

tools
Tools · array

List of tool names available to the agent

collaborators
Collaborators · array

List of other agent names this agent can collaborate with

llm
string | null

LLM identifier for the agent

supported_apps
enum<string>[] | null

Supported apps of the agent

points_to
string<uuid>[]

Environment IDs points to this version

comments
string | null

Comments added by the user while deploying an agent

mapped_environments
EnvironmentSchema · object[] | null

List of Environments points to the agent version

deleted_by
string | null
hidden
boolean
default:false

To show or hide agent when agents are listed

environments
EnvironmentSchema · object[]

List of simplified environments associated with the agent

deleted_at
string<date-time> | null
knowledge_base
string[] | null

List of knowledge_base available to the agent

display_name
string | null

Display name of the agent

structured_output
object | null

JSON schema defining the structure for agent responses

guidelines
Guideline · object[]

List of guidelines for the agent behavior

custom_join_tool
object | null

Reference to a Python tool ID that will be used for custom synthesis of task results

tags
string[] | null

List of tags associated to agent

voice_configuration_id
string<uuid> | null

Voice configuration for the agent

deployment_status
string | null

Status of the agent deployment

chat_with_docs
object

Chat with Documents config for Agent

additional_properties
object | null

Agent Additional Settings A specification for settings within an agent

context_access_enabled
boolean
default:true

Enable access to context variables for this agent

context_variables
string[]

List of context variable names that this agent can access