Create a conversation

Base URL: https://{kibana_url}

POST /api/security_ai_assistant/current_user/conversations
POST /s/{space_id}/api/security_ai_assistant/current_user/conversations

Refer to Spaces for more information.

Create a new Security AI Assistant conversation. This endpoint allows the user to initiate a conversation with the Security AI Assistant by providing the required parameters.

Authentication

Api key

Authorization: <value>

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 base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

apiConfig object
category enum: The conversation category.; Values: assistant insights
excludeFromLastConversationStorage boolean: Exclude from last conversation storage.
id string: The conversation id.
messages object[]: The conversation messages.
replacements map string to string: Replacements object used to anonymize/deanonymize messages
title string required: The conversation title.

Responses

Indicates a successful call. The conversation was created successfully.

application/json

apiConfig object
category enum required: The conversation category.; Values: assistant insights
createdAt string required: The time conversation was created.
createdBy object required: Could be any string, not necessarily a UUID.
excludeFromLastConversationStorage boolean: Exclude from last conversation storage.
id string · format: nonempty · min length: 1 required: A string that does not contain only whitespace characters.
messages object[]: The conversation messages.; Same fields as messages
namespace string required: Kibana space
replacements map string to string: Replacements object used to anonymize/deanonymize messages
timestamp string · format: nonempty · min length: 1: A string that represents a timestamp in ISO 8601 format and does not contain only whitespace characters.
title string required: The conversation title.
updatedAt string: The last time conversation was updated.
users object[] required

Bad Request response.

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request POST 'http://localhost:5601/api/security_ai_assistant/current_user/conversations' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"title":"Security Discussion","category":"assistant","messages":[{"content":"Hello","role":"system","timestamp":"2023-10-31T12:00:00Z"}],"apiConfig":{"connectorId":"12345","actionTypeId":"67890"},"replacements":{},"excludeFromLastConversationStorage":false}'

Request

Request example

{
  "apiConfig": {
    "actionTypeId": "67890",
    "connectorId": "12345"
  },
  "category": "assistant",
  "excludeFromLastConversationStorage": false,
  "messages": [
    {
      "content": "Hello, how can I assist you today?",
      "role": "system",
      "timestamp": "2023-10-31T12:00:00Z"
    }
  ],
  "replacements": {},
  "title": "Security Discussion"
}

Response

{
  "apiConfig": {
    "actionTypeId": "67890",
    "connectorId": "12345"
  },
  "category": "assistant",
  "createdAt": "2023-10-31T12:01:00Z",
  "createdBy": {
    "id": "user1",
    "name": "John Doe"
  },
  "excludeFromLastConversationStorage": false,
  "id": "abc123",
  "messages": [
    {
      "content": "Hello, how can I assist you today?",
      "role": "system",
      "timestamp": "2023-10-31T12:00:00Z"
    }
  ],
  "namespace": "default",
  "replacements": {},
  "title": "Security Discussion",
  "updatedAt": "2023-10-31T12:01:00Z",
  "users": [
    {
      "id": "user1",
      "name": "John Doe"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "Missing required parameter: title",
  "statusCode": 400
}

Authentication

Request body { }

Responses

Request body