POST /api/security_ai_assistant/current_user/conversations
Api key auth

Spaces method and path for this operation:

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.

application/json

Body Required

  • apiConfig object
    Hide apiConfig attributes Show apiConfig attributes object
    • actionTypeId string Required

      Action type ID

    • connectorId string Required

      Connector ID

    • defaultSystemPromptId string

      Default system prompt ID

    • model string

      Model

    • provider string

      Provider

      Values are OpenAI, Azure OpenAI, or Other.

  • category string

    The conversation category.

    Values are assistant or insights.

  • excludeFromLastConversationStorage boolean

    Exclude from last conversation storage.

  • id string

    The conversation id.

  • messages array[object]

    The conversation messages.

    Hide messages attributes Show messages attributes object

    AI assistant conversation message.

    • content string Required

      Message content.

    • id string(nonempty)

      A string that does not contain only whitespace characters.

      Minimum length is 1.

    • isError boolean

      Is error message.

    • metadata object

      Message metadata

      Hide metadata attributes Show metadata attributes object
      • contentReferences object

        A union of all content reference types

      • interruptResumeValue object

        Union of the interrupt resume values

        One of:
        object-2 object object-2 object

      • interruptValue object

        Union of the interrupt values

        One of:
        object-2 object object-2 object
    • reader object

      Additional properties are allowed.

    • refusal string

      Refusal reason returned by the model when content is filtered.

    • role string Required

      Message role.

      Values are system, user, or assistant.

    • timestamp string(nonempty) Required

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

      Minimum length is 1.

    • traceData object

      Trace Data

      Hide traceData attributes Show traceData attributes object
      • traceId string

        Could be any string, not necessarily a UUID

      • transactionId string

        Could be any string, not necessarily a UUID

    • user object

      Could be any string, not necessarily a UUID.

      Hide user attributes Show user attributes object
      • id string

        User id.

      • name string

        User name.

  • replacements object

    Replacements object used to anonymize/deanonymize messages

    Hide replacements attribute Show replacements attribute object
    • * string Additional properties
  • title string Required

    The conversation title.

Responses

  • 200 application/json

    Indicates a successful call. The conversation was created successfully.

    Hide response attributes Show response attributes object
    • apiConfig object
      Hide apiConfig attributes Show apiConfig attributes object
      • actionTypeId string Required

        Action type ID

      • connectorId string Required

        Connector ID

      • defaultSystemPromptId string

        Default system prompt ID

      • model string

        Model

      • provider string

        Provider

        Values are OpenAI, Azure OpenAI, or Other.

    • category string Required

      The conversation category.

      Values are assistant or insights.

    • createdAt string Required

      The time conversation was created.

    • createdBy object Required

      Could be any string, not necessarily a UUID.

      Hide createdBy attributes Show createdBy attributes object
      • id string

        User id.

      • name string

        User name.

    • excludeFromLastConversationStorage boolean

      Exclude from last conversation storage.

    • id string(nonempty) Required

      A string that does not contain only whitespace characters.

      Minimum length is 1.

    • messages array[object]

      The conversation messages.

      Hide messages attributes Show messages attributes object

      AI assistant conversation message.

      • content string Required

        Message content.

      • id string(nonempty)

        A string that does not contain only whitespace characters.

        Minimum length is 1.

      • isError boolean

        Is error message.

      • metadata object

        Message metadata

        Hide metadata attributes Show metadata attributes object
        • contentReferences object

          A union of all content reference types

        • interruptResumeValue object

          Union of the interrupt resume values

          One of:
          object-2 object object-2 object

        • interruptValue object

          Union of the interrupt values

          One of:
          object-2 object object-2 object
      • reader object

        Additional properties are allowed.

      • refusal string

        Refusal reason returned by the model when content is filtered.

      • role string Required

        Message role.

        Values are system, user, or assistant.

      • timestamp string(nonempty) Required

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

        Minimum length is 1.

      • traceData object

        Trace Data

        Hide traceData attributes Show traceData attributes object
        • traceId string

          Could be any string, not necessarily a UUID

        • transactionId string

          Could be any string, not necessarily a UUID

      • user object

        Could be any string, not necessarily a UUID.

        Hide user attributes Show user attributes object
        • id string

          User id.

        • name string

          User name.

    • namespace string Required

      Kibana space

    • replacements object

      Replacements object used to anonymize/deanonymize messages

      Hide replacements attribute Show replacements attribute object
      • * string Additional properties
    • timestamp string(nonempty)

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

      Minimum length is 1.

    • title string Required

      The conversation title.

    • updatedAt string

      The last time conversation was updated.

    • users array[object] Required
      Hide users attributes Show users attributes object

      Could be any string, not necessarily a UUID.

      • id string

        User id.

      • name string

        User name.
  • 400 application/json

    Bad Request response.

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode number
POST /api/security_ai_assistant/current_user/conversations 
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 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 examples (200) 
{
  "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"
    }
  ]
}
Response examples (400) 
{
  "error": "Bad Request",
  "message": "Missing required parameter: title",
  "statusCode": 400
}