List agents

Server: https://{kibana_url}

GET /api/agent_builder/agents

List all available agents. Use this endpoint to retrieve complete agent information including their current configuration and assigned tools. To learn more about agents, refer to the agents documentation.

[Required authorization] Route required privileges: agentBuilder:read.

Response

200

Indicates a successful response

application/json

Examples

Example response that returns one built-in Elastic agent and one created by the user

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/agent_builder/agents

curl Shell

curl \
 -X GET "${KIBANA_URL}/api/agent_builder/agents" \
 -H "Authorization: ApiKey ${API_KEY}"

Response

{
  "results": [
    {
      "access_control": "null",
      "configuration": {
        "tools": [
          {
            "tool_ids": [
              "platform.core.search",
              "platform.core.list_indices",
              "platform.core.get_index_mapping",
              "platform.core.get_document_by_id"
            ]
          }
        ]
      },
      "description": "Elastic AI Agent",
      "id": "elastic-ai-agent",
      "name": "Elastic AI Agent",
      "permissions": {
        "update_access_control": false,
        "update_agent": false
      },
      "type": "chat"
    },
    {
      "access_control": {
        "access_mode": "private",
        "entries": [
          {
            "name": "alice",
            "role": "manager",
            "type": "user"
          }
        ]
      },
      "avatar_color": "#BFDBFF",
      "avatar_symbol": "SI",
      "configuration": {
        "instructions": "You are a custom agent that wants to help searching data using all indices starting with prefix \u0022content-\u0022.",
        "tools": [
          {
            "tool_ids": [
              "platform.core.search",
              "platform.core.list_indices",
              "platform.core.get_index_mapping",
              "platform.core.get_document_by_id"
            ]
          }
        ]
      },
      "description": "Hi! I can help you search the data within the indices starting with \u0022content-\u0022 prefix.",
      "id": "created-agent-id",
      "labels": [
        "custom-indices",
        "department-search"
      ],
      "name": "Search Index Helper",
      "permissions": {
        "update_access_control": true,
        "update_agent": true
      },
      "type": "chat"
    }
  ]
}