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

LLM API configuration.
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)
  
  Message id
  
  Minimum length is 1.
- isError boolean
  
  Is error message.
- metadata object
  
  Metadata
  Hide metadata attributes Show metadata attributes object
  
  contentReferences object
  
  Data referred to by the message content.
  
  interruptResumeValue object
  
  One of:
  object object
  
  When the agent is resumed after an interrupt, this field is populated with the details of the resume value.
  
  Hide attributes Show attributes
  
  type string Required
  
  Type of the resume value
  
  Value is SELECT_OPTION.
  
  value string Required
  
  The value of the selected option to resume the graph execution with
  
  When the agent is resumed after an interrupt, this field is populated with the details of the resume value.
  
  Hide attributes Show attributes
  
  type string Required
  
  Type of the resume value
  
  Value is INPUT_TEXT.
  
  value string Required
  
  Text value used to resume the graph execution with.
  
  interruptValue object
  
  One of:
  object object
  
  When the agent is interrupted (for example, when user input is required), this field is populated with the details of the interrupt. Messages containing interruptValues in the metadata are excluded from the LLM context.
  
  Hide attributes Show attributes
  
  expired boolean
  
  Whether the interrupt has expired and can no longer be resumed.
  
  threadId string Required
  
  Thread ID of the graph execution that produced this message.
  
  type string Required
  
  Type of the interrupt
  
  Value is SELECT_OPTION.
  
  description string Required
  
  Description of action required
  
  options array[object] Required
  
  List of actions to choose from
  
  Hide options attributes Show options attributes object
  
  A request approval option
  
  buttonColor string
  
  Values are text, accent, accentSecondary, primary, success, warning, danger, neutral, or risk.
  
  label string Required
  
  value string Required
  
  When the agent is interrupted (for example, when user input is required), this field is populated with the details of the interrupt. Messages containing interruptValues in the metadata are excluded from the LLM context.
  
  Hide attributes Show attributes
  
  expired boolean
  
  Whether the interrupt has expired and can no longer be resumed.
  
  threadId string Required
  
  Thread ID of the graph execution that produced this message.
  
  type string Required
  
  Type of the interrupt
  
  Value is INPUT_TEXT.
  
  description string
  
  Description of action required
  
  placeholder string
  
  Placeholder text for the input field
- reader object
  
  Message content.
  
  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
  
  The timestamp message was sent or received.
  
  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
  
  The user who sent the message.
  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
  
  LLM API configuration.
  
  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
  
  The user who created the conversation.
  
  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)
  
  Message id
  
  Minimum length is 1.
  
  isError boolean
  
  Is error message.
  
  metadata object
  
  Metadata
  
  Hide metadata attributes Show metadata attributes object
  
  contentReferences object
  
  Data referred to by the message content.
  
  interruptResumeValue object
  
  One of:
  object object
  
  When the agent is resumed after an interrupt, this field is populated with the details of the resume value.
  
  Hide attributes Show attributes
  
  type string Required
  
  Type of the resume value
  
  Value is SELECT_OPTION.
  
  value string Required
  
  The value of the selected option to resume the graph execution with
  
  When the agent is resumed after an interrupt, this field is populated with the details of the resume value.
  
  Hide attributes Show attributes
  
  type string Required
  
  Type of the resume value
  
  Value is INPUT_TEXT.
  
  value string Required
  
  Text value used to resume the graph execution with.
  
  interruptValue object
  
  One of:
  object object
  
  When the agent is interrupted (for example, when user input is required), this field is populated with the details of the interrupt. Messages containing interruptValues in the metadata are excluded from the LLM context.
  
  Hide attributes Show attributes
  
  expired boolean
  
  Whether the interrupt has expired and can no longer be resumed.
  
  threadId string Required
  
  Thread ID of the graph execution that produced this message.
  
  type string Required
  
  Type of the interrupt
  
  Value is SELECT_OPTION.
  
  description string Required
  
  Description of action required
  
  options array[object] Required
  
  List of actions to choose from
  
  Hide options attributes Show options attributes object
  
  A request approval option
  
  buttonColor string
  
  Values are text, accent, accentSecondary, primary, success, warning, danger, neutral, or risk.
  
  label string Required
  
  value string Required
  
  When the agent is interrupted (for example, when user input is required), this field is populated with the details of the interrupt. Messages containing interruptValues in the metadata are excluded from the LLM context.
  
  Hide attributes Show attributes
  
  expired boolean
  
  Whether the interrupt has expired and can no longer be resumed.
  
  threadId string Required
  
  Thread ID of the graph execution that produced this message.
  
  type string Required
  
  Type of the interrupt
  
  Value is INPUT_TEXT.
  
  description string
  
  Description of action required
  
  placeholder string
  
  Placeholder text for the input field
  
  reader object
  
  Message content.
  
  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
  
  The timestamp message was sent or received.
  
  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
  
  The user who sent the message.
  
  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
  
  Could be any string, not necessarily a UUID.
  
  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

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

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",
  "excludeFromLastConversationStorage": false,
  "id": "abc123",
  "messages": [
    {
      "content": "Hello, how can I assist you today?",
      "role": "system",
      "timestamp": "2023-10-31T12:00:00Z"
    }
  ],
  "replacements": {},
  "title": "Security Discussion",
  "updatedAt": "2023-10-31T12:01:00Z",
  "users": [
    {
      "id": "user1",
      "name": "John Doe"
    }
  ]
}

Create a conversation

Body Required

interruptResumeValue object

interruptValue object

Responses

interruptResumeValue object

interruptValue object