The identity and technical contract details declared by the specification.
Security_AI_Assistant_API_KnowledgeBaseResponse400
object
3 properties
Security_AI_Assistant_API_InputTextInterruptResumeValue
A resume value for input text
Security_AI_Assistant_API_DocumentEntryRequiredFields
object
4 properties
4 required
Security_AI_Assistant_API_InputTextInterruptValue
Interrupt that requests user to provide text input
Security_AI_Assistant_API_DocumentEntryOptionalFields
object
2 properties
Security_AI_Assistant_API_NormalizedAnonymizationFieldError
object
4 properties
3 required
Security_AI_Assistant_API_BaseInterruptValue
object
The basis of an agent interrupt
3 properties
2 required
Security_AI_Assistant_API_ResponseFields
object
5 properties
5 required
Security_AI_Assistant_API_DocumentEntryResponseFields
Security_AI_Assistant_API_Message
object
AI assistant conversation message.
10 properties
3 required
Security_AI_Assistant_API_IndexEntryCreateFields
Security_AI_Assistant_API_ConversationCategory
string
The conversation category.
Security_AI_Assistant_API_SecurityAlertsPageContentReference
References the security alerts page
Security_AI_Assistant_API_ConversationResponse
object
13 properties
7 required
Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResponse
object
5 properties
1 required
Security_AI_Assistant_API_HrefContentReference
References an external URL
Security_AI_Assistant_API_PromptType
string
Type of the prompt (either system or quick).
Security_AI_Assistant_API_PromptUpdateProps
object
7 properties
1 required
Security_AI_Assistant_API_KnowledgeBaseResource
string
Knowledge Base resource name for grouping entries, e.g. 'securitylabs', 'user', etc.
Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipReason
string
Reason why the anonymization field was not modified.
Security_AI_Assistant_API_IndexEntry
Security_AI_Assistant_API_DocumentEntryUpdateFields
Security_AI_Assistant_API_KnowledgeBaseEntryBulkCrudActionResults
object
4 properties
4 required
Security_AI_Assistant_API_KnowledgeBaseEntryBulkActionSkipResult
object
3 properties
2 required
Security_AI_Assistant_API_AnonymizationFieldCreateProps
object
3 properties
1 required
Security_AI_Assistant_API_SelectOptionInterruptOption
object
A request approval option
3 properties
2 required
Security_AI_Assistant_API_Provider
string
Provider
Security_AI_Assistant_API_SelectOptionInterruptResumeValue
A request approval resume schema
Security_AI_Assistant_API_FindKnowledgeBaseEntriesSortField
string
Fields available for sorting Knowledge Base Entries.
Security_AI_Assistant_API_AnonymizationFieldsBulkActionSkipResult
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_BaseInterruptResumeValue
object
The basis of an interrupt resume value
1 property
1 required
Security_AI_Assistant_API_PromptDetailsInError
object
2 properties
1 required
Security_AI_Assistant_API_PromptsBulkCrudActionResults
object
4 properties
4 required
Security_AI_Assistant_API_PromptResponse
object
16 properties
4 required
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_NormalizedKnowledgeBaseEntryError
object
4 properties
3 required
Security_AI_Assistant_API_DeleteResponseFields
object
1 property
1 required
Security_AI_Assistant_API_KnowledgeBaseEntryBulkCrudActionResponse
object
5 properties
1 required
Security_AI_Assistant_API_KnowledgeBaseEntryUpdateProps
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_InterruptResumeValue
Union of the interrupt resume values
Security_AI_Assistant_API_InterruptValue
Union of the interrupt values
Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps
Security_AI_Assistant_API_SecurityAlertContentReference
References a security alert
Security_AI_Assistant_API_IndexEntryUpdateFields
Security_AI_Assistant_API_InterruptType
string
The type of interrupt
Security_AI_Assistant_API_KnowledgeBaseEntryErrorSchema
object
3 properties
3 required
Security_AI_Assistant_API_BulkCrudActionSummary
object
4 properties
4 required
Security_AI_Assistant_API_AnonymizationFieldResponse
object
10 properties
2 required
Security_AI_Assistant_API_IndexEntryRequiredFields
object
5 properties
5 required
Security_AI_Assistant_API_ChatMessage
object
A message exchanged within the AI chat conversation.
4 properties
1 required
Security_AI_Assistant_API_KnowledgeBaseEntryCreateProps
Security_AI_Assistant_API_IndexEntryOptionalFields
object
2 properties
Security_AI_Assistant_API_PromptCreateProps
object
8 properties
3 required
Security_AI_Assistant_API_IndexEntryResponseFields
Security_AI_Assistant_API_NormalizedPromptError
object
4 properties
3 required
Security_AI_Assistant_API_KnowledgeBaseEntryBulkCrudActionSummary
object
4 properties
4 required
Security_AI_Assistant_API_FindAnonymizationFieldsSortField
string
Security_AI_Assistant_API_EsqlContentReference
References an ESQL query
Security_AI_Assistant_API_PromptsBulkActionSkipResult
object
3 properties
2 required
Security_AI_Assistant_API_AnonymizationFieldUpdateProps
object
3 properties
1 required
Security_AI_Assistant_API_SortOrder
string
The order in which results are sorted.
Security_AI_Assistant_API_KnowledgeBaseResponse
object
AI assistant KnowledgeBase.
1 property
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_KnowledgeBaseEntryDetailsInError
object
2 properties
1 required
Security_AI_Assistant_API_ConversationCreateProps
object
7 properties
1 required
Security_AI_Assistant_API_MessageRole
string
Message role.
Security_AI_Assistant_API_AnonymizationFieldDetailsInError
object
2 properties
1 required
Security_AI_Assistant_API_AnonymizationFieldsBulkCrudActionResults
object
4 properties
4 required
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_KnowledgeBaseEntryBulkActionSkipReason
string
Reason why a Knowledge Base Entry was skipped during the bulk action.
Security_AI_Assistant_API_ConversationUpdateProps
object
8 properties
1 required
Security_AI_Assistant_API_KnowledgeBaseEntryResponse
Security_AI_Assistant_API_DocumentEntry
Security_AI_Assistant_API_MessageMetadata
object
Message metadata
3 properties
Security_AI_Assistant_API_SelectOptionInterruptValue
Interrupt that requests user to select one of the provided options
Security_AI_Assistant_API_Replacements
object
Replacements object used to anonymize/deanonymize messages
Security_AI_Assistant_API_ContentReferences
object
A union of all content reference types
Security_AI_Assistant_API_ProductDocumentationContentReference
References the product documentation
Security_AI_Assistant_API_KnowledgeBaseReadResponse200
object
7 properties
Security_AI_Assistant_API_BaseContentReference
object
The basis of a content reference
2 properties
2 required
Security_AI_Assistant_API_FindPromptsSortField
string
Field by which to sort the prompts.
Security_AI_Assistant_API_TraceData
object
Trace Data
2 properties
Security_AI_Assistant_API_ChatMessageRole
string
The role associated with the message in the chat.
Security_AI_Assistant_API_User
object
Could be any string, not necessarily a UUID.
2 properties
Security_AI_Assistant_API_KnowledgeBaseEntryContentReference
References a knowledge base entry
Security_AI_Assistant_API_NonEmptyString
string
A string that does not contain only whitespace characters.
Security_AI_Assistant_API_Reader
object
Security_AI_Assistant_API_PromptsBulkActionSkipReason
string
Reason why a prompt was skipped during the bulk action.
Security_AI_Assistant_API_DocumentEntryCreateFields
Security_AI_Assistant_API_PromptsBulkCrudActionResponse
object
5 properties
1 required
Security_AI_Assistant_API_ApiConfig
object
5 properties
2 required
Security_AI_Assistant_API_MessageData
object
ECS-style metadata attached to the message.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Elastic Stack (ELK Stack) publishes across the network.
