Skip to content

Commit 7a81bf2

Browse files
leemthomporhr323
authored andcommitted
[agent builder] Update serverless API doc links (elastic#3421)
closes elastic#3366
1 parent 7647587 commit 7a81bf2

File tree

4 files changed

+56
-7
lines changed

4 files changed

+56
-7
lines changed

solutions/search/agent-builder/agent-builder-agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,4 @@ For an overview, refer to [Agents API](kibana-api.md#agents).
125125

126126
### Serverless API reference
127127

128-
For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/).
128+
For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-agents).

solutions/search/agent-builder/chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ For a quick overview of the REST API for conversations, refer to [Chat and conve
7272

7373
### Serverless API reference
7474

75-
For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/).
75+
For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-conversations).
7676

7777

7878

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

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ These pages are currently hidden from the docs TOC and have `noindexed` meta hea
1414

1515
# Work with {{agent-builder}} using the APIs
1616

17-
This page provides a quick overview of the main Kibana API endpoints for {{agent-builder}}. For complete details including all available parameters, request/response schemas, and error handling, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/).
17+
This page provides a quick overview of the main Kibana API endpoints for {{agent-builder}}. For complete details including all available parameters, request/response schemas, and error handling, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-agent-builder).
1818

1919
These APIs allow you to programmatically work with the {{agent-builder}} abstractions.
2020

@@ -51,6 +51,9 @@ To generate API keys, search for `API keys` in the [global search bar](/explore-
5151
### Tools
5252

5353
**Example:** List all tools
54+
55+
This example uses the [list tools API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-tools).
56+
5457
::::{tab-set}
5558
:group: api-examples
5659

@@ -72,6 +75,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/tools" \
7275
::::
7376

7477
**Example:** Create a tool
78+
79+
This example uses the [create a tool API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-tools).
80+
7581
::::{tab-set}
7682
:group: api-examples
7783

@@ -133,6 +139,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/tools" \
133139
::::
134140

135141
**Example:** Get a tool by ID
142+
143+
This example uses the [get a tool by ID API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-tools-id).
144+
136145
::::{tab-set}
137146
:group: api-examples
138147

@@ -154,6 +163,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/tools/{id}" \
154163
::::
155164

156165
**Example:** Delete a tool by ID
166+
167+
This example uses the [delete a tool by ID API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-delete-agent-builder-tools-id).
168+
157169
::::{tab-set}
158170
:group: api-examples
159171

@@ -176,6 +188,9 @@ curl -X DELETE "https://${KIBANA_URL}/api/agent_builder/tools/{id}" \
176188
::::
177189

178190
**Example:** Update a tool by ID
191+
192+
This example uses the [update a tool API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-put-agent-builder-tools-toolid).
193+
179194
::::{tab-set}
180195
:group: api-examples
181196

@@ -233,6 +248,9 @@ curl -X PUT "https://${KIBANA_URL}/api/agent_builder/tools/{toolId}" \
233248
::::
234249

235250
**Example:** Run a tool
251+
252+
This example uses the [execute a tool API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-tools-execute).
253+
236254
::::{tab-set}
237255
:group: api-examples
238256

@@ -270,6 +288,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/tools/_execute" \
270288
### Agents
271289
272290
**Example:** List all agents
291+
292+
This example uses the [list agents API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-agents).
293+
273294
::::{tab-set}
274295
:group: api-examples
275296
@@ -291,6 +312,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/agents" \
291312
::::
292313
293314
**Example:** Create an agent
315+
316+
This example uses the [create an agent API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-agents).
317+
294318
::::{tab-set}
295319
:group: api-examples
296320
@@ -356,6 +380,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/agents" \
356380
::::
357381

358382
**Example:** Get an agent by ID
383+
384+
This example uses the [get an agent by ID API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-agents-id).
385+
359386
::::{tab-set}
360387
:group: api-examples
361388

@@ -377,6 +404,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/agents/{id}" \
377404
::::
378405

379406
**Example:** Update an agent by ID
407+
408+
This example uses the [update an agent API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-put-agent-builder-agents-id).
409+
380410
::::{tab-set}
381411
:group: api-examples
382412

@@ -436,6 +466,9 @@ curl -X PUT "https://${KIBANA_URL}/api/agent_builder/agents/{id}" \
436466
::::
437467

438468
**Example:** Delete an agent by ID
469+
470+
This example uses the [delete an agent by ID API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-delete-agent-builder-agents-id).
471+
439472
::::{tab-set}
440473
:group: api-examples
441474

@@ -460,6 +493,9 @@ curl -X DELETE "https://${KIBANA_URL}/api/agent_builder/agents/{id}" \
460493
### Chat and conversations
461494

462495
**Example:** Chat with an agent
496+
497+
This example uses the [send chat message API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-converse).
498+
463499
::::{tab-set}
464500
:group: api-examples
465501

@@ -490,6 +526,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/converse" \
490526
::::
491527

492528
**Example:** Chat with an agent and stream events
529+
530+
This example uses the [send chat message (streaming) API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-converse-async).
531+
493532
::::{tab-set}
494533
:group: api-examples
495534

@@ -523,6 +562,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/converse/async" \
523562
::::
524563

525564
**Example:** List conversations
565+
566+
This example uses the [list conversations API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-conversations).
567+
526568
::::{tab-set}
527569
:group: api-examples
528570

@@ -544,6 +586,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/conversations" \
544586
::::
545587

546588
**Example:** Get conversation by ID
589+
590+
This example uses the [get conversation by ID API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-conversations-conversation-id).
591+
547592
::::{tab-set}
548593
:group: api-examples
549594

@@ -565,6 +610,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/conversations/{conversation
565610
::::
566611

567612
**Example:** Delete conversation by ID
613+
614+
This example uses the [delete conversation by ID API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-delete-agent-builder-conversations-conversation-id).
615+
568616
::::{tab-set}
569617
:group: api-examples
570618

@@ -590,7 +638,6 @@ curl -X DELETE "https://${KIBANA_URL}/api/agent_builder/conversations/{conversat
590638

591639
Refer to [](mcp-server.md) for more information.
592640

593-
594641
Communicate with the MCP server using JSON-RPC 2.0.
595642

596643
```bash
@@ -615,6 +662,9 @@ This endpoint uses the JSON-RPC protocol. The MCP server is used by AI clients l
615662
Refer to [](a2a-server.md) for more information.
616663

617664
**Example:** Get A2A agent card configuration
665+
666+
This example uses the [get A2A agent card API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-a2a-agentid-json).
667+
618668
::::{tab-set}
619669
:group: api-examples
620670

@@ -679,5 +729,4 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/a2a/{agentId}.json" \
679729

680730
## API reference
681731

682-
For the full API documentation, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/).
683-
% TODO: Update link once page is live
732+
For the full API documentation, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-agent-builder).

solutions/search/agent-builder/tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ For a quick overview of how to work programmatically with tools, refer to [Tools
198198

199199
### Serverless API reference
200200

201-
For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/).
201+
For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-tools).
202202

203203
## Copy your MCP server URL
204204

0 commit comments

Comments
 (0)