Create a KnowledgeBase

Base URL: https://{kibana_url}

POST /api/security_ai_assistant/knowledge_base
POST /s/{space_id}/api/security_ai_assistant/knowledge_base

Auth

Create a knowledge base. Use this endpoint when no specific resource identifier is needed.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

modelId string: ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.; Example: elser-model-001
ignoreSecurityLabs boolean · default: false: Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to false.

Responses

Indicates a successful call.

application/json

success boolean: Identify the success of the method execution.

Bad Request response.

application/json

error string: A short description of the error.
message string: A detailed error message.
statusCode number: The HTTP status code of the error.

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request POST 'http://localhost:5601/api/security_ai_assistant/knowledge_base?ignoreSecurityLabs=false' \
 --header "Authorization: $API_KEY"

Response

{
  "success": true
}

statusCode: 400 error: Bad Request message: "[request query]: ignoreSecurityLabs: Invalid enum value. Expected 'true' | 'false', received 'yes', ignoreSecurityLabs: Expected boolean, received string"