Create a conversation

POST /api/security_ai_assistant/current_user/conversations

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.

AI assistant conversation message.
Hide messages attributes Show messages attributes object
- content string Required
  
  Message content.
- isError boolean
  
  Is error message.
- metadata object
  
  Message metadata
  Hide metadata attribute Show metadata attribute object
  
  contentReferences object
  
  A union of all content reference types
- reader object
  
  Additional properties are allowed.
- 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
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.
- 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.
  
  AI assistant conversation message.
  
  Hide messages attributes Show messages attributes object
  
  content string Required
  
  Message content.
  
  isError boolean
  
  Is error message.
  
  metadata object
  
  Message metadata
  
  Hide metadata attribute Show metadata attribute object
  
  contentReferences object
  
  A union of all content reference types
  
  reader object
  
  Additional properties are allowed.
  
  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
- namespace string Required
  
  Kibana space
- replacements object
  
  Replacements object used to anonymize/deanonymize messages
  
  Hide replacements attribute Show replacements attribute object
  
  * string Additional properties
- summary object
  
  Hide summary attributes Show summary attributes object
  
  confidence string
  
  The conversation confidence.
  
  Values are low, medium, or high.
  
  content string
  
  Summary text of the conversation over time.
  
  public boolean
  
  Define if summary is marked as publicly available.
  
  timestamp string(nonempty)
  
  A string that represents a timestamp in ISO 8601 format and does not contain only whitespace characters.
  
  Minimum length is 1.
- 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
  
  Could be any string, not necessarily a UUID.
  
  Hide users attributes Show users attributes object
  
  id string
  
  User id.
  
  name string
  
  User name.
400 application/json

Generic Error. This response indicates an issue with the request, such as missing required parameters or incorrect data.
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

POST /api/security_ai_assistant/current_user/conversations

curl \ --request POST 'https://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":[{"role":"system","content":"Hello, how can I assist you today?","timestamp":"2023-10-31T12:00:00Z"}],"apiConfig":{"connectorId":"12345","actionTypeId":"67890"},"replacements":{},"excludeFromLastConversationStorage":false}'

Request example

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

Response examples (200)

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