Get an agent by ID

Base URL: https://{kibana_url}

GET /api/agent_builder/agents/{id}
GET /s/{space_id}/api/agent_builder/agents/{id}

Refer to Spaces for more information.

Get a specific agent by ID. Use this endpoint to retrieve the complete agent definition including all configuration details and tool assignments. To learn more about agents, refer to the agents documentation.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/agent_builder/agents/{id}

curl Shell

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

Response

Example response that an agent created by the user that will query elasticsearch indices starting with 'content-' prefix to answer the questions.

{
  "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"
}