Kibana Security AI Assistant API API
Manage and interact with Security Assistant resources.
Kibana Security AI Assistant API API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Security AI Assistant API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 21 operations across 14 paths, and defines 94 schemas. It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
21 operations
14 paths
94 schemas
3 DELETE8 GET8 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Kibana Security AI Assistant API API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiKeyAuth— These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…
Paths & Operations 21
Across 14 paths, the API surfaces 21 operations — 3 DELETE, 8 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Security AI Assistant API 21
Manage and interact with Security Assistant resources.
POST
/api/security_ai_assistant/anonymization_fields/_bulk_action
Apply a bulk action to anonymization fields
GET
/api/security_ai_assistant/anonymization_fields/_find
Get anonymization fields
POST
/api/security_ai_assistant/chat/complete
Create a model response
DELETE
/api/security_ai_assistant/current_user/conversations
Delete conversations
POST
/api/security_ai_assistant/current_user/conversations
Create a conversation
GET
/api/security_ai_assistant/current_user/conversations/_find
Get conversations
DELETE
/api/security_ai_assistant/current_user/conversations/{id}
Delete a conversation
GET
/api/security_ai_assistant/current_user/conversations/{id}
Get a conversation
PUT
/api/security_ai_assistant/current_user/conversations/{id}
Update a conversation
GET
/api/security_ai_assistant/knowledge_base
Read a KnowledgeBase
POST
/api/security_ai_assistant/knowledge_base
Create a KnowledgeBase
GET
/api/security_ai_assistant/knowledge_base/{resource}
Read a KnowledgeBase for a resource
POST
/api/security_ai_assistant/knowledge_base/{resource}
Create a KnowledgeBase for a resource
POST
/api/security_ai_assistant/knowledge_base/entries
Create a Knowledge Base Entry
POST
/api/security_ai_assistant/knowledge_base/entries/_bulk_action
Applies a bulk action to multiple Knowledge Base Entries
GET
/api/security_ai_assistant/knowledge_base/entries/_find
Finds Knowledge Base Entries that match the given query.
DELETE
/api/security_ai_assistant/knowledge_base/entries/{id}
Deletes a single Knowledge Base Entry using the id field
GET
/api/security_ai_assistant/knowledge_base/entries/{id}
Read a Knowledge Base Entry
PUT
/api/security_ai_assistant/knowledge_base/entries/{id}
Update a Knowledge Base Entry
POST
/api/security_ai_assistant/prompts/_bulk_action
Apply a bulk action to prompts
GET
/api/security_ai_assistant/prompts/_find
Get prompts
Schemas 94
The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are Security_AI_Assistant_API_PromptResponse (16 properties), Security_AI_Assistant_API_ConversationResponse (13 properties), Security_AI_Assistant_API_ChatCompleteProps (10 properties), Security_AI_Assistant_API_AnonymizationFieldResponse (10 properties). Each schema is shown below with its type and property counts.
Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResults
object
4 properties
4 required
Security_AI_Assistant_API_KnowledgeBaseEntryBulkActionSkipResult
object
3 properties
2 required
Security_AI_Assistant_API_Replacements
object
Replacements object used to anonymize/deanonymize messages
Security_AI_Assistant_API_KnowledgeBaseEntryUpdateProps
Security_AI_Assistant_API_KnowledgeBaseEntryBulkCrudActionSummary
object
4 properties
4 required
Security_AI_Assistant_API_KnowledgeBaseEntryBulkCrudActionResponse
object
5 properties
1 required
Security_AI_Assistant_API_KnowledgeBaseReadResponse200
object
7 properties
Security_AI_Assistant_API_MessageRole
string
Message role.
Security_AI_Assistant_API_KnowledgeBaseEntryResponse
Security_AI_Assistant_API_BaseInterruptResumeValue
object
The basis of an interrupt resume value
1 property
1 required
Security_AI_Assistant_API_AnonymizationFieldResponse
object
10 properties
2 required
Security_AI_Assistant_API_ConversationCategory
string
The conversation category.
Security_AI_Assistant_API_TraceData
object
Trace Data
2 properties
Security_AI_Assistant_API_ContentReferences
object
A union of all content reference types
Security_AI_Assistant_API_KnowledgeBaseEntryCreateProps
Security_AI_Assistant_API_InputTextInterruptValue
Interrupt that requests user to provide text input
Security_AI_Assistant_API_ResponseFields
object
5 properties
5 required
Security_AI_Assistant_API_Reader
object
Security_AI_Assistant_API_ChatMessageRole
string
The role associated with the message in the chat.
Security_AI_Assistant_API_KnowledgeBaseEntryBulkActionSkipReason
string
Reason why a Knowledge Base Entry was skipped during the bulk action.
Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipReason
string
Reason why the anonymization field was not modified.
Security_AI_Assistant_API_InputTextInterruptResumeValue
A resume value for input text
Security_AI_Assistant_API_FindAnonymizationFieldsSortField
string
Security_AI_Assistant_API_SortOrder
string
The order in which results are sorted.
Security_AI_Assistant_API_PromptDetailsInError
object
2 properties
1 required
Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResponse
object
5 properties
1 required
Security_AI_Assistant_API_DocumentEntry
Security_AI_Assistant_API_SecurityAlertsPageContentReference
References the security alerts page
Security_AI_Assistant_API_NonEmptyString
string
A string that does not contain only whitespace characters.
Security_AI_Assistant_API_FindConversationsSortField
string
The field by which to sort the conversations. Possible values are createdat, title, and updatedat.
Security_AI_Assistant_API_PromptUpdateProps
object
7 properties
1 required
Security_AI_Assistant_API_PromptResponse
object
16 properties
4 required
Security_AI_Assistant_API_ConversationResponse
object
13 properties
7 required
Security_AI_Assistant_API_InterruptValue
Union of the interrupt values
Security_AI_Assistant_API_SelectOptionInterruptValue
Interrupt that requests user to select one of the provided options
Security_AI_Assistant_API_BaseContentReference
object
The basis of a content reference
2 properties
2 required
Security_AI_Assistant_API_ProductDocumentationContentReference
References the product documentation
Security_AI_Assistant_API_SelectOptionInterruptOption
object
A request approval option
3 properties
2 required
Security_AI_Assistant_API_IndexEntryUpdateFields
Security_AI_Assistant_API_MessageData
object
ECS-style metadata attached to the message.
Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps
Security_AI_Assistant_API_User
object
Could be any string, not necessarily a UUID.
2 properties
Security_AI_Assistant_API_KnowledgeBaseEntryErrorSchema
object
3 properties
3 required
Security_AI_Assistant_API_BaseInterruptValue
object
The basis of an agent interrupt
3 properties
2 required
Security_AI_Assistant_API_KnowledgeBaseEntryDetailsInError
object
2 properties
1 required
Security_AI_Assistant_API_DocumentEntryRequiredFields
object
4 properties
4 required
Security_AI_Assistant_API_InterruptType
string
The type of interrupt
Security_AI_Assistant_API_PromptCreateProps
object
8 properties
3 required
Security_AI_Assistant_API_EsqlContentReference
References an ESQL query
Security_AI_Assistant_API_InterruptResumeValue
Union of the interrupt resume values
Security_AI_Assistant_API_PromptType
string
Type of the prompt (either system or quick).
Security_AI_Assistant_API_KnowledgeBaseResponse400
object
3 properties
Security_AI_Assistant_API_DocumentEntryUpdateFields
Security_AI_Assistant_API_IndexEntryOptionalFields
object
2 properties
Security_AI_Assistant_API_KnowledgeBaseResource
string
Knowledge Base resource name for grouping entries, e.g. 'securitylabs', 'user', etc.
Security_AI_Assistant_API_ConversationCreateProps
object
7 properties
1 required
Security_AI_Assistant_API_KnowledgeBaseEntryContentReference
References a knowledge base entry
Security_AI_Assistant_API_PromptsBulkActionSkipResult
object
3 properties
2 required
Security_AI_Assistant_API_ChatCompleteProps
object
The request payload for creating a chat completion.
10 properties
3 required
Security_AI_Assistant_API_ConversationUpdateProps
object
8 properties
1 required
Security_AI_Assistant_API_HrefContentReference
References an external URL
Security_AI_Assistant_API_ChatMessage
object
A message exchanged within the AI chat conversation.
4 properties
1 required
Security_AI_Assistant_API_FindPromptsSortField
string
Field by which to sort the prompts.
Security_AI_Assistant_API_PromptsBulkCrudActionResponse
object
5 properties
1 required
Security_AI_Assistant_API_IndexEntryRequiredFields
object
5 properties
5 required
Security_AI_Assistant_API_AnonymizationFieldCreateProps
object
3 properties
1 required
Security_AI_Assistant_API_Message
object
AI assistant conversation message.
10 properties
3 required
Security_AI_Assistant_API_NormalizedAnonymizationFieldError
object
4 properties
3 required
Security_AI_Assistant_API_KnowledgeBaseResponse
object
AI assistant KnowledgeBase.
1 property
Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipResult
object
3 properties
2 required
Security_AI_Assistant_API_SelectOptionInterruptResumeValue
A request approval resume schema
Security_AI_Assistant_API_AnonymizationFieldUpdateProps
object
3 properties
1 required
Security_AI_Assistant_API_FindKnowledgeBaseEntriesSortField
string
Fields available for sorting Knowledge Base Entries.
Security_AI_Assistant_API_MessageMetadata
object
Message metadata
3 properties
Security_AI_Assistant_API_NormalizedKnowledgeBaseEntryError
object
4 properties
3 required
Security_AI_Assistant_API_AnonymizationFieldDetailsInError
object
2 properties
1 required
Security_AI_Assistant_API_IndexEntryResponseFields
Security_AI_Assistant_API_DeleteResponseFields
object
1 property
1 required
Security_AI_Assistant_API_PromptsBulkCrudActionResults
object
4 properties
4 required
Security_AI_Assistant_API_SecurityAlertContentReference
References a security alert
Security_AI_Assistant_API_IndexEntryCreateFields
Security_AI_Assistant_API_KnowledgeBaseEntryBulkCrudActionResults
object
4 properties
4 required
Security_AI_Assistant_API_DocumentEntryOptionalFields
object
2 properties
Security_AI_Assistant_API_Vector
object
Object containing Knowledge Base Entry text embeddings and modelId used to create the embeddings.
2 properties
2 required
Security_AI_Assistant_API_PromptsBulkActionSkipReason
string
Reason why a prompt was skipped during the bulk action.
Security_AI_Assistant_API_ApiConfig
object
5 properties
2 required
Security_AI_Assistant_API_DocumentEntryResponseFields
Security_AI_Assistant_API_Provider
string
Provider
Security_AI_Assistant_API_BulkCrudActionSummary
object
4 properties
4 required
Security_AI_Assistant_API_IndexEntry
Security_AI_Assistant_API_InputSchema
array
Array of objects defining the input schema, allowing the LLM to extract structured data to be used in retrieval.
Security_AI_Assistant_API_DocumentEntryCreateFields
Security_AI_Assistant_API_NonEmptyTimestamp
string
A string that represents a timestamp in ISO 8601 format and does not contain only whitespace characters.
Security_AI_Assistant_API_NormalizedPromptError
object
4 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kibana 12
Other APIs Kibana publishes across the network.
Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API
#Security AI Assistant API