Get an agent by ID
Base URL
https://{kibana_url}
Auth
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 .
Privileges
agentBuilder:read
Expand all
space_id
string optional
An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
id
string required
The unique identifier of the agent to retrieve.
200
Indicates a successful response
application/json
Thank you for your feedback.
Base URL
https://{kibana_url}
Examples
Request
Console
1 / 2 languages
‹
›
1
GET kbn://api/agent_builder/agents/{id}
1
2
3
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.
Show more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"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,
"update_approvals": true
},
"type": "chat"
}