GET
/
orchestrate
/
agents
List Registered Agents.
curl --request GET \
  --url http://localhost/api/v1/orchestrate/agents \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "knowledge_base": [],
    "llm": "<string>",
    "style": "default",
    "supported_apps": [
      "slack/askhr"
    ],
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_by": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "environments": [],
    "agent_mapping": {},
    "hidden": true,
    "display_name": "<string>",
    "structured_output": {},
    "custom_join_tool": "<string>",
    "guidelines": [],
    "tags": [
      "<string>"
    ],
    "chat_with_docs": {
      "enabled": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 123,
        "chunk_overlap": 123,
        "limit": 123
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "<string>",
        "generated_response_length": "Concise",
        "display_text_no_results_found": "<string>",
        "display_text_connectivity_issue": "<string>"
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "<string>",
        "citations_shown": 123
      },
      "hap_filtering": {
        "output": {
          "enabled": true,
          "threshold": 123
        }
      }
    },
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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.

Query Parameters

include_hidden
boolean
default:false
ids
string<uuid>[] | null
names
string[] | null

Response

200
application/json

Successful Response

The response is of type ListAgent · object[].