List agents Technical Preview

GET /api/agent_builder/agents
Api key auth

List all available agents. Use this endpoint to retrieve complete agent information including their current configuration and assigned tools.

[Required authorization] Route required privileges: read_onechat.

Responses

  • 200 application/json

    Indicates a successful response

GET /api/agent_builder/agents 
curl \
 --request GET 'https://<KIBANA_URL>/api/agent_builder/agents' \
 --header "Authorization: $API_KEY"
Response examples (200)
Example response that returns one built-in Elastic agent and one created by the user 
{
  "results": [
    {
      "id": "elastic-ai-agent",
      "name": "Elastic AI Agent",
      "type": "chat",
      "description": "Elastic AI Agent",
      "configuration": {
        "tools": [
          {
            "tool_ids": [
              "platform.core.search",
              "platform.core.list_indices",
              "platform.core.get_index_mapping",
              "platform.core.get_document_by_id"
            ]
          }
        ]
      }
    },
    {
      "id": "created-agent-id",
      "name": "Search Index Helper",
      "type": "chat",
      "labels": [
        "custom-indices",
        "department-search"
      ],
      "description": "Hi! I can help you search the data within the indices starting with \"content-\" prefix.",
      "avatar_color": "#BFDBFF",
      "avatar_symbol": "SI",
      "configuration": {
        "tools": [
          {
            "tool_ids": [
              "platform.core.search",
              "platform.core.list_indices",
              "platform.core.get_index_mapping",
              "platform.core.get_document_by_id"
            ]
          }
        ],
        "instructions": "You are a custom agent that wants to help searching data using all indices starting with prefix \"content-\"."
      }
    }
  ]
}