From ba7ce93d7085dd7a815a1efb423b3a227aa31a39 Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Thu, 9 Oct 2025 10:24:12 +0200 Subject: [PATCH] [agent builder] Update serverless API doc links --- .../agent-builder/agent-builder-agents.md | 2 +- solutions/search/agent-builder/chat.md | 2 +- solutions/search/agent-builder/kibana-api.md | 57 +++++++++++++++++-- solutions/search/agent-builder/tools.md | 2 +- 4 files changed, 56 insertions(+), 7 deletions(-) diff --git a/solutions/search/agent-builder/agent-builder-agents.md b/solutions/search/agent-builder/agent-builder-agents.md index 8d9ea140f3..e0aabcad7e 100644 --- a/solutions/search/agent-builder/agent-builder-agents.md +++ b/solutions/search/agent-builder/agent-builder-agents.md @@ -125,4 +125,4 @@ For an overview, refer to [Agents API](kibana-api.md#agents). ### Serverless API reference -For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/). \ No newline at end of file +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). \ No newline at end of file diff --git a/solutions/search/agent-builder/chat.md b/solutions/search/agent-builder/chat.md index e14655502f..eec65d6fbb 100644 --- a/solutions/search/agent-builder/chat.md +++ b/solutions/search/agent-builder/chat.md @@ -72,7 +72,7 @@ For a quick overview of the REST API for conversations, refer to [Chat and conve ### Serverless API reference -For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/). +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). diff --git a/solutions/search/agent-builder/kibana-api.md b/solutions/search/agent-builder/kibana-api.md index a4272cda5f..7e58bdedc9 100644 --- a/solutions/search/agent-builder/kibana-api.md +++ b/solutions/search/agent-builder/kibana-api.md @@ -14,7 +14,7 @@ These pages are currently hidden from the docs TOC and have `noindexed` meta hea # Work with {{agent-builder}} using the APIs -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/). +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). These APIs allow you to programmatically work with the {{agent-builder}} abstractions. @@ -51,6 +51,9 @@ To generate API keys, search for `API keys` in the [global search bar](/explore- ### Tools **Example:** List all tools + +This example uses the [list tools API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-tools). + ::::{tab-set} :group: api-examples @@ -72,6 +75,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/tools" \ :::: **Example:** Create a tool + +This example uses the [create a tool API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-tools). + ::::{tab-set} :group: api-examples @@ -133,6 +139,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/tools" \ :::: **Example:** Get a tool by ID + +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). + ::::{tab-set} :group: api-examples @@ -154,6 +163,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/tools/{id}" \ :::: **Example:** Delete a tool by ID + +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). + ::::{tab-set} :group: api-examples @@ -176,6 +188,9 @@ curl -X DELETE "https://${KIBANA_URL}/api/agent_builder/tools/{id}" \ :::: **Example:** Update a tool by ID + +This example uses the [update a tool API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-put-agent-builder-tools-toolid). + ::::{tab-set} :group: api-examples @@ -233,6 +248,9 @@ curl -X PUT "https://${KIBANA_URL}/api/agent_builder/tools/{toolId}" \ :::: **Example:** Run a tool + +This example uses the [execute a tool API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-tools-execute). + ::::{tab-set} :group: api-examples @@ -270,6 +288,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/tools/_execute" \ ### Agents **Example:** List all agents + +This example uses the [list agents API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-agents). + ::::{tab-set} :group: api-examples @@ -291,6 +312,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/agents" \ :::: **Example:** Create an agent + +This example uses the [create an agent API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-agents). + ::::{tab-set} :group: api-examples @@ -356,6 +380,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/agents" \ :::: **Example:** Get an agent by ID + +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). + ::::{tab-set} :group: api-examples @@ -377,6 +404,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/agents/{id}" \ :::: **Example:** Update an agent by ID + +This example uses the [update an agent API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-put-agent-builder-agents-id). + ::::{tab-set} :group: api-examples @@ -436,6 +466,9 @@ curl -X PUT "https://${KIBANA_URL}/api/agent_builder/agents/{id}" \ :::: **Example:** Delete an agent by ID + +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). + ::::{tab-set} :group: api-examples @@ -460,6 +493,9 @@ curl -X DELETE "https://${KIBANA_URL}/api/agent_builder/agents/{id}" \ ### Chat and conversations **Example:** Chat with an agent + +This example uses the [send chat message API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-converse). + ::::{tab-set} :group: api-examples @@ -490,6 +526,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/converse" \ :::: **Example:** Chat with an agent and stream events + +This example uses the [send chat message (streaming) API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-agent-builder-converse-async). + ::::{tab-set} :group: api-examples @@ -523,6 +562,9 @@ curl -X POST "https://${KIBANA_URL}/api/agent_builder/converse/async" \ :::: **Example:** List conversations + +This example uses the [list conversations API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-agent-builder-conversations). + ::::{tab-set} :group: api-examples @@ -544,6 +586,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/conversations" \ :::: **Example:** Get conversation by ID + +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). + ::::{tab-set} :group: api-examples @@ -565,6 +610,9 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/conversations/{conversation :::: **Example:** Delete conversation by ID + +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). + ::::{tab-set} :group: api-examples @@ -590,7 +638,6 @@ curl -X DELETE "https://${KIBANA_URL}/api/agent_builder/conversations/{conversat Refer to [](mcp-server.md) for more information. - Communicate with the MCP server using JSON-RPC 2.0. ```bash @@ -615,6 +662,9 @@ This endpoint uses the JSON-RPC protocol. The MCP server is used by AI clients l Refer to [](a2a-server.md) for more information. **Example:** Get A2A agent card configuration + +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). + ::::{tab-set} :group: api-examples @@ -679,5 +729,4 @@ curl -X GET "https://${KIBANA_URL}/api/agent_builder/a2a/{agentId}.json" \ ## API reference -For the full API documentation, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/). -% TODO: Update link once page is live \ No newline at end of file +For the full API documentation, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-agent-builder). \ No newline at end of file diff --git a/solutions/search/agent-builder/tools.md b/solutions/search/agent-builder/tools.md index 57a6535853..a1e0c88b9c 100644 --- a/solutions/search/agent-builder/tools.md +++ b/solutions/search/agent-builder/tools.md @@ -198,7 +198,7 @@ For a quick overview of how to work programmatically with tools, refer to [Tools ### Serverless API reference -For the complete API reference, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/). +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). ## Copy your MCP server URL