Update an agent

PUT /api/agent_builder/agents/{id}

Spaces method and path for this operation:

put /s/{space_id}/api/agent_builder/agents/{id}

Refer to Spaces for more information.

Update an existing agent configuration. Use this endpoint to modify any aspect of the agent's behavior, appearance, or capabilities. To learn more, refer to the agents documentation.

[Required authorization] Route required privileges: agentBuilder:manageAgents.

Headers

kbn-xsrf string Required

A required header to protect against CSRF attacks

Path parameters

id string Required

The unique identifier of the agent to update.

application/json

Body

avatar_color string

Updated hex color code for the agent avatar.
avatar_symbol string

Updated symbol/initials for the agent avatar.
configuration object

Updated configuration settings for the agent.

Additional properties are NOT allowed.
Hide configuration attributes Show configuration attributes object
- enable_elastic_capabilities boolean
  
  When true, enables built-in Elastic capabilities for the agent.
- instructions string
  
  Updated system instructions that define the agent behavior.
- skill_ids array[string]
  
  Array of skill IDs to be available to the agent.
  
  Not more than 100 elements.
- tools array[object]
  
  Tool selection configuration for the agent.
  Hide tools attribute Show tools attribute object
  
  tool_ids array[string] Required
  
  Array of tool IDs that the agent can use.
- workflow_ids array[string]
  
  Updated list of workflow IDs. When set, these workflows run every agent execution, in order.
  
  Not more than 100 elements.
description string

Updated description of what the agent does.
labels array[string]

Updated labels for categorizing and organizing agents.
name string

Updated display name for the agent.
visibility string

Technical Preview; added in 9.4.0. Updated visibility setting: public (any privileged user can read/write), shared (any privileged user can read, only owner can write), private (only owner can read/write).

Values are public, shared, or private.

Responses

200 application/json

Indicates a successful response

PUT /api/agent_builder/agents/{id}

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"
        ]
      }]
    }
  }'

PUT kbn://api/agent_builder/agents/{id}
{
  "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"
      ]
    }]
  }
}

Request example

Example request for updating custom agent

{
  "id": "created-agent-id",
  "name": "Search Index Helper",
  "labels": [
    "custom-indices",
    "department-search",
    "elastic-employees"
  ],
  "description": "Updated description - Search for anything in \"content-*\" indices!",
  "avatar_color": "#BFDBFF",
  "avatar_symbol": "SI",
  "configuration": {
    "tools": [
      {
        "tool_ids": [
          "platform.core.search",
          "platform.core.list_indices",
          "platform.core.get_index_mapping",
          "platform.core.get_document_by_id"
        ]
      }
    ],
    "instructions": "You are a custom agent that wants to help searching data using all indices starting with prefix \"content-\"."
  }
}

Response examples (200)

Example response returning the agent definition with the changes applied from the request

{
  "id": "created-agent-id",
  "name": "Search Index Helper",
  "type": "chat",
  "labels": [
    "custom-indices",
    "department-search",
    "elastic-employees"
  ],
  "description": "Updated description - Search for anything in \"content-*\" indices!",
  "avatar_color": "#BFDBFF",
  "avatar_symbol": "SI",
  "configuration": {
    "tools": [
      {
        "tool_ids": [
          "platform.core.search",
          "platform.core.list_indices",
          "platform.core.get_index_mapping",
          "platform.core.get_document_by_id"
        ]
      }
    ],
    "instructions": "You are a custom agent that wants to help searching data using all indices starting with prefix \"content-\"."
  }
}