Get an agent by ID Technical Preview

GET /api/agent_builder/agents/{id}
Api key auth

Get a specific agent by ID. Use this endpoint to retrieve the complete agent definition including all configuration details and tool assignments.

[Required authorization] Route required privileges: read_onechat.

Path parameters

  • id string Required

    The unique identifier of the agent to retrieve.

Responses

  • 200 application/json

    Indicates a successful response

GET /api/agent_builder/agents/{id} 
curl \ --request GET 'https://<KIBANA_URL>/api/agent_builder/agents/{id}' \ --header "Authorization: $API_KEY"
Response examples (200)
Example response that an agent created by the user that will query elasticsearch indices starting with 'content-' prefix to answer the questions. 
{ "id": "created-agent-id", "name": "Search Index Helper", "type": "chat", "labels": [ "custom-indices", "department-search" ], "description": "Hi! I can help you search the data within the indices starting with \"content-\" prefix.", "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-\"." } }