GET
/
orchestrate
/
agents
/
environment
/
{environment_name}
/
releases
List Versioned Agents By Environment Name
curl --request GET \
  --url http://localhost/api/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": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "",
        "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"
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Low",
        "response_confidence_threshold": "Low"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      }
    },
    "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

200
application/json

Successful Response

The response is of type ListAgentVersion · object[].