Get List Of Agent Versions By Id.

Lists all agent versions by agentid.

Get List Of Agent Versions By Id.

cURL

curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/{id}/releases \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "version_label": 123,
    "style": "default",
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "llm": "<string>",
    "supported_apps": [
      "slack/askhr"
    ],
    "points_to": [],
    "comments": "<string>",
    "mapped_environments": [],
    "deleted_by": "<string>",
    "hidden": false,
    "environments": [],
    "deleted_at": "2023-11-07T05:31:56Z",
    "knowledge_base": [],
    "display_name": "<string>",
    "structured_output": {},
    "guidelines": [],
    "custom_join_tool": {},
    "tags": [],
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deployment_status": "<string>",
    "chat_with_docs": {
      "enabled": false,
      "supports_full_document": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10,
        "extraction_strategy": "standard"
      },
      "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
        }
      },
      "query_source": "Agent",
      "agent_query_description": "The query to search for in the knowledge base"
    },
    "additional_properties": {
      "starter_prompts": {
        "customize": [
          {
            "title": "<string>",
            "prompt": "<string>",
            "id": "<string>",
            "subtitle": "<string>",
            "state": "<string>"
          }
        ]
      },
      "welcome_content": {
        "welcome_message": "<string>",
        "description": "<string>"
      }
    },
    "context_access_enabled": true,
    "context_variables": [],
    "hide_reasoning": false
  }
]

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> · required

Response

200

application/json

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, react_intrinsic

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 · (string | object)[]

List of tool names available to the agent

collaborators · (string | object)[]

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

Available options: slack/askhr

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

Show child attributes

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

Show child attributes

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 · Structured Output · object

JSON schema defining the structure for agent responses

guidelines · Guideline · object[]

List of guidelines for the agent behavior

Show child attributes

custom_join_tool · Custom Join Tool · object

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 · ChatWithDocsConfig · object

Chat with Documents config for Agent

Show child attributes

additional_properties · AgentAdditionalProperties · object

Agent Additional Settings

Show child attributes

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

hide_reasoning · boolean · default: false

Enable/disable reasoning trace