Skip to content

Commit 8f0d6a2

Browse files
committed
Tidy up Kibana API page, make non-Console usage clear
1 parent 4f4a568 commit 8f0d6a2

File tree

1 file changed

+81
-22
lines changed

1 file changed

+81
-22
lines changed

solutions/search/agent-builder/kibana-api.md

Lines changed: 81 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,83 +14,142 @@ These APIs allow you to programmatically work with the {{agent-builder}} abstrac
1414

1515
For the full API documentation, refer to the [Kibana API reference](https://www.elastic.co/docs/api/doc/kibana/).
1616

17-
For information on generating API keys, see [API keys](https://www.elastic.co/docs/solutions/search/search-connection-details).
17+
## Using the APIs
18+
19+
The examples in this documentation use Dev Tools [Console](/explore-analyze/query-filter/tools/console.md) syntax.
20+
```console
21+
GET kbn://api/agent_builder/tools
22+
```
23+
24+
To use these APIs with tools like `curl`, replace the `kbn://` protocol with your Kibana URL.
25+
26+
27+
```bash
28+
curl -X GET "https://<KIBANA_URL>/api/agent_builder/tools" \
29+
-H "Authorization: ApiKey <API_KEY>"
30+
```
31+
:::{tip}
32+
To generate API keys, search for `API keys` in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
33+
[Learn more](https://www.elastic.co/docs/solutions/search/search-connection-details).
34+
:::
1835

1936
## Available APIs
2037
% TODO: we may remove this list once the API reference is live, but probably helpful in the short term
2138

2239
### Tools
2340

2441
List all tools
25-
: `GET kbn://api/agent_builder/tools`
42+
: ```console
43+
GET kbn://api/agent_builder/tools
44+
```
2645

2746
Create a tool
28-
: `POST kbn://api/agent_builder/tools`
47+
: ```console
48+
POST kbn://api/agent_builder/tools
49+
```
2950

3051
Get a tool by ID
31-
: `GET kbn://api/agent_builder/tools/{id}`
52+
: ```console
53+
GET kbn://api/agent_builder/tools/{id}
54+
```
3255

3356
Delete a tool by ID
34-
: `DELETE kbn://api/agent_builder/tools/{id}`
57+
: ```console
58+
DELETE kbn://api/agent_builder/tools/{id}
59+
```
3560

3661
Update a tool by ID
37-
: `PUT kbn://api/agent_builder/tools/{toolId}`
62+
: ```console
63+
PUT kbn://api/agent_builder/tools/{toolId}
64+
```
3865

3966
Execute a tool
40-
: `POST kbn://api/agent_builder/tools/_execute`
67+
: ```console
68+
POST kbn://api/agent_builder/tools/_execute
69+
```
4170

4271
### Agents
4372

4473
List all agents
45-
: `GET kbn://api/agent_builder/agents`
74+
: ```console
75+
GET kbn://api/agent_builder/agents
76+
```
4677

4778
Create an agent
48-
: `POST kbn://api/agent_builder/agents`
79+
: ```console
80+
POST kbn://api/agent_builder/agents
81+
```
4982

5083
Get an agent by ID
51-
: `GET kbn://api/agent_builder/agents/{id}`
84+
: ```console
85+
GET kbn://api/agent_builder/agents/{id}
86+
```
5287

5388
Update an agent by ID
54-
: `PUT kbn://api/agent_builder/agents/{id}`
89+
: ```console
90+
PUT kbn://api/agent_builder/agents/{id}
91+
```
5592

5693
Delete an agent by ID
57-
: `DELETE kbn://api/agent_builder/agents/{id}`
94+
: ```console
95+
DELETE kbn://api/agent_builder/agents/{id}
96+
```
5897

5998
### Chat and Conversations
6099

61100
Chat with an agent
62-
: `POST kbn://api/agent_builder/converse`
101+
: ```console
102+
POST kbn://api/agent_builder/converse
103+
```
63104

64105
Chat with an agent and stream events
65-
: `POST kbn://api/agent_builder/converse/async`
106+
: ```console
107+
POST kbn://api/agent_builder/converse/async
108+
```
66109

67110
List conversations
68-
: `GET kbn://api/agent_builder/conversations`
111+
: ```console
112+
GET kbn://api/agent_builder/conversations
113+
```
69114

70115
Get conversation by ID
71-
: `GET kbn://api/agent_builder/conversations/{conversation_id}`
116+
: ```console
117+
GET kbn://api/agent_builder/conversations/{conversation_id}
118+
```
72119

73120
Delete conversation by ID
74-
: `DELETE kbn://api/agent_builder/conversations/{conversation_id}`
121+
: ```console
122+
DELETE kbn://api/agent_builder/conversations/{conversation_id}
123+
```
75124

76125
### MCP Server
77126

78127
Get MCP server configuration
79-
: `GET kbn://api/agent_builder/mcp`
128+
: ```console
129+
GET kbn://api/agent_builder/mcp
130+
```
80131

81132
Create or configure MCP server
82-
: `POST kbn://api/agent_builder/mcp`
133+
: ```console
134+
POST kbn://api/agent_builder/mcp
135+
```
83136

84137
Delete MCP server configuration
85-
: `DELETE kbn://api/agent_builder/mcp`
138+
: ```console
139+
DELETE kbn://api/agent_builder/mcp
140+
```
86141

87142
### A2A Protocol
88143

89144
Refer to [](a2a-server.md) for more information.
90145

91146
Get A2A agent card configuration
92-
: `GET kbn://api/agent_builder/a2a/{agentId}.json`
147+
: ```console
148+
GET kbn://api/agent_builder/a2a/{agentId}.json
149+
```
93150

94151
Execute A2A agent task
95-
: `POST kbn://api/agent_builder/a2a/{agentId}`
152+
: ```console
153+
POST kbn://api/agent_builder/a2a/{agentId}
154+
```
96155

0 commit comments

Comments
 (0)