--- title: Elastic Agent Builder Kibana APIs overview description: Use the Agent Builder Kibana REST APIs to programmatically manage agents, tools, skills, and conversation history. url: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/ai-features/agent-builder/kibana-api products: - Elastic Cloud Serverless - Elastic Observability - Elastic Security - Elasticsearch - Kibana applies_to: - Elastic Cloud Serverless: Generally available - Elastic Stack: Generally available since 9.3, Preview in 9.2 --- # Elastic Agent Builder Kibana APIs overview This page provides a quick overview of the main Kibana API endpoints for Elastic Agent Builder. For complete details including all available parameters, request/response schemas, and error handling, refer to the [Kibana API reference](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-agent-builder). These APIs enable you to programmatically work with Elastic Agent Builder abstractions such as agents, tools, and skills. New to the Elastic Agent Builder APIs? Try our hands-on [API tutorial](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/ai-features/agent-builder/agent-builder-api-tutorial) that walks you through creating custom tools and agents step-by-step. ## Using the APIs The examples in this documentation use Dev Tools [Console](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/query-filter/tools/console) syntax. ```json ``` To use these APIs with tools like `curl`, replace the `kbn://` protocol with your Kibana URL. Set the required environment variables before running curl commands: ```bash export KIBANA_URL="your-kibana-url" export API_KEY="your-api-key" ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/tools" \ -H "Authorization: ApiKey ${API_KEY}" ``` To generate API keys, search for `API keys` in the [global search bar](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/find-and-organize/find-apps-and-objects). [Learn more](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/solutions/elasticsearch-solution-project/search-connection-details). ### Working with spaces To run APIs in non-default [spaces](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/deploy-manage/manage-spaces), you must include the space identifier in the URL when making API calls with `curl` or other external tools. Insert `/s/` before `/api/agent_builder` in your requests. For example, to list tools in a space named `my-space`: ```bash curl -X GET "${KIBANA_URL}/s/my-space/api/agent_builder/tools" \ -H "Authorization: ApiKey ${API_KEY}" ``` The default space does not require the `/s/default` prefix. Dev Tools [Console](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/query-filter/tools/console) automatically uses your current space context and does not require the `/s/` prefix. ## Available APIs The following sections provide quick examples for each API endpoint grouped by resource type. ### Tools APIs Use these APIs to create, list, update, delete, and run tools. **Example:** List all tools This example uses the [list tools API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-tools). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/tools" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Create a tool This example uses the [create a tool API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-tools). ```json { "id": "example-esql-tool", "type": "esql", "description": "An ES|QL query tool for analyzing financial trades with time filtering", "tags": ["analytics", "finance", "updated"], "configuration": { "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit", "params": { "startTime": { "type": "date", "description": "Start time for the analysis in ISO format" }, "limit": { "type": "integer", "description": "Maximum number of results to return" } } } } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/tools" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "id": "example-esql-tool", "type": "esql", "description": "Example ES|QL query tool for analyzing financial trades with time filtering", "tags": ["analytics", "finance"], "configuration": { "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit", "params": { "startTime": { "type": "date", "description": "Start time for the analysis in ISO format" }, "limit": { "type": "integer", "description": "Maximum number of results to return" } } } }' ``` **Example:** Create a tool with [default values](/elastic/docs-content/pull/6201/explore-analyze/ai-features/agent-builder/tools/esql-tools#default-values-for-optional-parameters) for optional parameters Elastic Stack: Generally available since 9.3 This example creates an ES|QL tool with optional parameters that have default values, which are automatically used when the agent doesn't provide them. ```json { "id": "sales-analysis-tool", "type": "esql", "description": "Analyze sales data with optional time filtering and automatic defaults for unspecified parameters", "tags": ["analytics", "sales"], "configuration": { "query": "FROM sales | WHERE timestamp >= ?start_date AND region == ?region | STATS total_sales=SUM(amount) BY product | LIMIT ?limit", "params": { "start_date": { "type": "date", "description": "Start date for analysis. When not provided by the agent, defaults to '2024-01-01T00:00:00Z'", "optional": true, "defaultValue": "2024-01-01T00:00:00Z" }, "region": { "type": "string", "description": "Sales region to filter by. If omitted, defaults to 'ALL' to include all regions", "optional": true, "defaultValue": "ALL" }, "limit": { "type": "integer", "description": "Maximum results to return. When not specified, automatically limits to 50 results", "optional": true, "defaultValue": 50 } } } } ``` ```bash curl -X POST "https://${KIBANA_URL}/api/agent_builder/tools" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "id": "sales-analysis-tool", "type": "esql", "description": "Analyze sales data with optional time filtering and automatic defaults for unspecified parameters", "tags": ["analytics", "sales"], "configuration": { "query": "FROM sales | WHERE timestamp >= ?start_date AND region == ?region | STATS total_sales=SUM(amount) BY product | LIMIT ?limit", "params": { "start_date": { "type": "date", "description": "Start date for analysis. When not provided by the agent, defaults to \"2024-01-01T00:00:00Z\"", "optional": true, "defaultValue": "2024-01-01T00:00:00Z" }, "region": { "type": "string", "description": "Sales region to filter by. If omitted, defaults to \"ALL\" to include all regions", "optional": true, "defaultValue": "ALL" }, "limit": { "type": "integer", "description": "Maximum results to return. When not specified, automatically limits to 50 results", "optional": true, "defaultValue": 50 } } } }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Get a tool by ID This example uses the [get a tool by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-tools-toolid). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/tools/{id}" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Delete a tool by ID This example uses the [delete a tool by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-delete-agent-builder-tools-toolid). ```json ``` ```bash curl -X DELETE "${KIBANA_URL}/api/agent_builder/tools/{id}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Update a tool by ID This example uses the [update a tool API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-put-agent-builder-tools-toolid). ```json { "description": "Updated ES|QL query tool for analyzing financial trades with time filtering", "tags": ["analytics", "finance", "updated"], "configuration": { "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit", "params": { "startTime": { "type": "date", "description": "Start time for the analysis in ISO format" }, "limit": { "type": "integer", "description": "Maximum number of results to return" } } } } ``` ```bash curl -X PUT "${KIBANA_URL}/api/agent_builder/tools/{toolId}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "description": "Updated ES|QL query tool for analyzing financial trades with time filtering", "tags": ["analytics", "finance", "updated"], "configuration": { "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit", "params": { "startTime": { "type": "date", "description": "Start time for the analysis in ISO format" }, "limit": { "type": "integer", "description": "Maximum number of results to return" } } } }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Run a tool This example uses the [execute a tool API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-tools-execute). ```json { "tool_id": "platform.core.search", "tool_params": { "query": "can you find john doe's email from the employee index?" } } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/tools/_execute" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "tool_id": "platform.core.search", "tool_params": { "query": "can you find john doe's email from the employee index?"} } }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). ### Skills APIs Use these APIs to create, list, update, and delete skills. **Example:** List all skills This example uses the [list skills API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-skills). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/skills" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Create a skill This example uses the [create a skill API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-skills). ```json { "id": "my-log-triage-skill", "name": "Log Triage", "description": "Guides triage of application log errors: classify by severity, identify the affected service and host, and suggest remediation steps. Use when a user asks to investigate or summarize log errors.", "content": "## When to Use This Skill\n\nUse this skill when:\n- A user asks to investigate or summarize log errors\n- A user wants to understand the cause of application failures\n\n## Log Triage Process\n\n### 1. Identify the affected service\n- Query recent error logs using `platform.core.execute_esql`\n- Extract `service.name`, `host.name`, and `log.level` fields\n\n### 2. Classify by severity\n- Group errors by type and frequency\n- Note any spike in error rate\n\n### 3. Suggest remediation\n- Summarize the most common errors\n- Suggest next steps based on error patterns", "tool_ids": [ "platform.core.execute_esql", "platform.core.generate_esql", "platform.core.list_indices" ] } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/skills" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "id": "my-log-triage-skill", "name": "Log Triage", "description": "Guides triage of application log errors: classify by severity, identify the affected service and host, and suggest remediation steps. Use when a user asks to investigate or summarize log errors.", "content": "## When to Use This Skill\n\n...", "tool_ids": [ "platform.core.execute_esql", "platform.core.generate_esql", "platform.core.list_indices" ] }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Create a skill with referenced content This example uses the [create a skill API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-skills) with `referenced_content` to attach supporting files the agent can read selectively. ```json { "id": "my-log-triage-skill", "name": "Log Triage", "description": "Guides triage of application log errors. Use when a user asks to investigate or summarize log errors.", "content": "## Log Triage Process\n\nFor example ES|QL queries, see `./queries`.", "tool_ids": ["platform.core.execute_esql"], "referenced_content": [ { "name": "queries", "relativePath": "./queries", "content": "# Example Queries\n\n## Recent errors by service\n```esql\nFROM logs-* | WHERE log.level == \"error\" | STATS count = COUNT(*) BY service.name | SORT count DESC | LIMIT 10\n```" } ] } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/skills" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "id": "my-log-triage-skill", "name": "Log Triage", "description": "Guides triage of application log errors. Use when a user asks to investigate or summarize log errors.", "content": "## Log Triage Process\n\nFor example ES|QL queries, see `./queries`.", "tool_ids": ["platform.core.execute_esql"], "referenced_content": [ { "name": "queries", "relativePath": "./queries", "content": "# Example Queries\n\n## Recent errors by service\n```esql\nFROM logs-* | WHERE log.level == \"error\" | STATS count = COUNT(*) BY service.name | SORT count DESC | LIMIT 10\n```" } ] }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Get a skill by ID This example uses the [get a skill by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-skills-skillid). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/skills/{skillId}" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Update a skill This example uses the [update a skill API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-put-agent-builder-skills-skillid). ```json { "description": "Updated description with more specific trigger conditions.", "content": "## When to Use This Skill\n\n(updated instructions)", "tool_ids": [ "platform.core.execute_esql", "platform.core.generate_esql" ] } ``` ```bash curl -X PUT "${KIBANA_URL}/api/agent_builder/skills/{skillId}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "description": "Updated description with more specific trigger conditions.", "content": "## When to Use This Skill\n\n(updated instructions)", "tool_ids": [ "platform.core.execute_esql", "platform.core.generate_esql" ] }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Delete a skill This example uses the [delete a skill API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-delete-agent-builder-skills-skillid). ```json ``` ```bash curl -X DELETE "${KIBANA_URL}/api/agent_builder/skills/{skillId}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). ### Agents APIs Use these APIs to create, list, update, and delete agents, and to track token consumption. **Example:** List all agents This example uses the [list agents API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-agents). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/agents" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Create an agent This example uses the [create an agent API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-agents). ```json { "id": "new-agent-id", "name": "Search Index Helper", "description": "Hi! I can help you search the data within the indices starting with \"content-\" prefix.", "labels": ["custom-indices", "department-search"], "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 \"content-\".", "tools": [ { "tool_ids": [ "platform.core.search", "platform.core.list_indices", "platform.core.get_index_mapping", "platform.core.get_document_by_id" ] } ] } } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/agents" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "id": "new-agent-id", "name": "Search Index Helper", "description": "Hi! I can help you search the data within the indices starting with \"content-\" prefix.", "labels": ["custom-indices", "department-search"], "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 \"content-\".", "tools": [ { "tool_ids": [ "platform.core.search", "platform.core.list_indices", "platform.core.get_index_mapping", "platform.core.get_document_by_id" ] } ] } }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Get an agent by ID This example uses the [get an agent by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-agents-id). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/agents/{id}" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Update an agent by ID This example uses the [update an agent API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-put-agent-builder-agents-id). ```json { "name": "Search Index Helper", "description": "Updated description - Search for anything in \"content-*\" indices!", "labels": ["custom-indices", "department-search", "elastic-employees"], "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 \"content-\".", "tools": [{ "tool_ids": [ "platform.core.search", "platform.core.list_indices", "platform.core.get_index_mapping", "platform.core.get_document_by_id" ] }] } } ``` ```bash curl -X PUT "${KIBANA_URL}/api/agent_builder/agents/{id}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "name": "Search Index Helper", "description": "Updated description - Search for anything in \"content-*\" indices!", "labels": ["custom-indices", "department-search", "elastic-employees"], "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 \"content-\".", "tools": [{ "tool_ids": [ "platform.core.search", "platform.core.list_indices", "platform.core.get_index_mapping", "platform.core.get_document_by_id" ] }] } }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Delete an agent by ID This example uses the [delete an agent by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-delete-agent-builder-agents-id). ```json ``` ```bash curl -X DELETE "${KIBANA_URL}/api/agent_builder/agents/{id}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). ### Token consumption - Elastic Stack: Preview in 9.4 Use this API to retrieve per-conversation token usage data for a given agent. This endpoint requires the `manageAgents` privilege and provides cross-user visibility into token consumption across all conversations for the specified agent. The response includes input and output token counts, round counts, LLM call counts, and warnings for conversations with high token usage. No message content or tool results are exposed. This API provides visibility into token usage but does not support setting token limits or quotas. To understand how token usage is calculated and how to view per-response totals in the UI, refer to [Monitor token usage](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/ai-features/agent-builder/monitor-usage). **Example:** Get token consumption for an agent This example uses the [get agent consumption data API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-agents-agent-id-consumption) with default pagination. ```json { "size": 25, "sort_field": "updated_at", "sort_order": "desc" } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/agents/elastic-ai-agent/consumption" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "size": 25, "sort_field": "updated_at", "sort_order": "desc" }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Filter consumption data by username and warnings This example filters results to specific users and conversations that have high-token warnings, sorted by total token count. ```json { "size": 10, "sort_field": "total_tokens", "sort_order": "desc", "usernames": ["elastic", "admin"], "has_warnings": true } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/agents/elastic-ai-agent/consumption" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "size": 10, "sort_field": "total_tokens", "sort_order": "desc", "usernames": ["elastic", "admin"], "has_warnings": true }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Paginate through consumption results To paginate, pass the `search_after` value from the previous response. ```json { "size": 10, "sort_field": "updated_at", "sort_order": "desc", "search_after": [1709391000000, "2025-03-02T14:30:00Z"] } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/agents/elastic-ai-agent/consumption" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "size": 10, "sort_field": "updated_at", "sort_order": "desc", "search_after": [1709391000000, "2025-03-02T14:30:00Z"] }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). ### Chat and conversations Use these APIs to send messages to agents and manage conversation history. **Example:** Chat with an agent This example uses the [send chat message API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-converse). ```json { "input": "What is Elasticsearch?", "agent_id": "elastic-ai-agent" } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/converse" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "input": "What is Elasticsearch?", "agent_id": "elastic-ai-agent"}' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Chat with an agent and stream events This example uses the [send chat message (streaming) API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-agent-builder-converse-async). ```json { "input": "Hello again let's have an async chat", "agent_id": "elastic-ai-agent", "conversation_id": "" } ``` ```bash curl -X POST "${KIBANA_URL}/api/agent_builder/converse/async" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" \ -H "Content-Type: application/json" \ -d '{ "input": "Hello again let us have an async chat", "agent_id": "elastic-ai-agent", "conversation_id": "" }' ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** List conversations This example uses the [list conversations API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-conversations). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/conversations" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Get conversation by ID This example uses the [get conversation by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-conversations-conversation-id). ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/conversations/{conversation_id}" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). **Example:** Delete conversation by ID This example uses the [delete conversation by ID API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-delete-agent-builder-conversations-conversation-id). ```json ``` ```bash curl -X DELETE "${KIBANA_URL}/api/agent_builder/conversations/{conversation_id}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "kbn-xsrf: true" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). ### Get A2A agent card configuration Use this API to retrieve the A2A agent card configuration for a specific agent. You shouldn't use the REST APIs to interact with the A2A endpoint, apart from getting the A2A agent card configuration. To learn more about using the A2A protocol, refer to [Agent-to-Agent (A2A) server in Elastic Agent Builder](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/ai-features/agent-builder/a2a-server). **Example:** Get A2A agent card configuration ```json ``` ```bash curl -X GET "${KIBANA_URL}/api/agent_builder/a2a/{agentId}.json" \ -H "Authorization: ApiKey ${API_KEY}" ``` If you're using Spaces, you need to prefix `/api/agent_builder` with `/s/`. Refer to [Working with Spaces](#working-with-spaces). ## API reference For the full API documentation, refer to the [Kibana API reference](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-agent-builder). ## Tutorial Try the hands-on [API tutorial](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6201/explore-analyze/ai-features/agent-builder/agent-builder-api-tutorial) to get a feel for the flow of working with Agent Builder programmatically.