v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
Security AI Assistant API

Create a conversation

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security_ai_assistant/current_user/conversations</span></div>

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.

post/api/security_ai_assistant/current_user/conversations

Request body

category'assistant' | 'insights'

The conversation category.

excludeFromLastConversationStorageboolean

Exclude from last conversation storage.

idstring

The conversation id.

replacementsSecurityAIAssistantAPIReplacements

Replacements object used to anonymize/deanonymize messages

titlestring required

The conversation title.

Example request

{
  "apiConfig": {
    "actionTypeId": "actionType456",
    "connectorId": "connector123",
    "defaultSystemPromptId": "systemPrompt001",
    "model": "gpt-4",
    "provider": "OpenAI"
  },
  "category": "assistant",
  "id": "conversation123",
  "messages": [
    {
      "content": "Hello, how can I assist you today?",
      "id": "I am a string",
      "metadata": {
        "interruptResumeValue": {
          "type": "SELECT_OPTION",
          "value": "option_1"
        },
        "interruptValue": {
          "threadId": "<UUID>",
          "type": "SELECT_OPTION",
          "description": "Select one of the options",
          "options": [
            {
              "label": "Option 1"
            },
            {
              "label": "Option 2"
            }
          ]
        }
      },
      "role": "assistant",
      "timestamp": "2023-10-31T12:00:00Z",
      "traceData": {
        "traceId": "d9876543-f0a1-2345-6789-abcdef123456",
        "transactionId": "a1234567-bc89-0def-1234-56789abcdef0"
      },
      "user": {
        "id": "user123",
        "name": "John Doe"
      }
    }
  ],
  "title": "Security AI Assistant Setup"
}

Response

Indicates a successful call. The conversation was created successfully.

category'assistant' | 'insights' required

The conversation category.

createdAtstring required

The time conversation was created.

excludeFromLastConversationStorageboolean

Exclude from last conversation storage.

idstring nonempty required

A string that does not contain only whitespace characters.

namespacestring required

Kibana space

replacementsSecurityAIAssistantAPIReplacements

Replacements object used to anonymize/deanonymize messages

timestampstring nonempty

A string that represents a timestamp in ISO 8601 format and does not contain only whitespace characters.

titlestring required

The conversation title.

updatedAtstring

The last time conversation was updated.

Example response

{
  "apiConfig": {
    "actionTypeId": "actionType456",
    "connectorId": "connector123",
    "defaultSystemPromptId": "systemPrompt001",
    "model": "gpt-4",
    "provider": "OpenAI"
  },
  "category": "assistant",
  "createdAt": "2025-04-30T14:00:00Z",
  "createdBy": {
    "id": "user123",
    "name": "John Doe"
  },
  "id": "I am a string",
  "messages": [
    {
      "content": "Hello, how can I assist you today?",
      "id": "I am a string",
      "metadata": {
        "interruptResumeValue": {
          "type": "SELECT_OPTION",
          "value": "option_1"
        },
        "interruptValue": {
          "threadId": "<UUID>",
          "type": "SELECT_OPTION",
          "description": "Select one of the options",
          "options": [
            {
              "label": "Option 1"
            },
            {
              "label": "Option 2"
            }
          ]
        }
      },
      "role": "assistant",
      "timestamp": "2023-10-31T12:00:00Z",
      "traceData": {
        "traceId": "d9876543-f0a1-2345-6789-abcdef123456",
        "transactionId": "a1234567-bc89-0def-1234-56789abcdef0"
      },
      "user": {
        "id": "user123",
        "name": "John Doe"
      }
    }
  ],
  "namespace": "default",
  "timestamp": "2023-10-31T12:00:00Z",
  "title": "Security AI Assistant Setup",
  "updatedAt": "2025-04-30T16:30:00Z",
  "users": [
    {
      "id": "user123",
      "name": "John Doe"
    }
  ]
}