Update a conversation

Base URL: https://{kibana_url}

PUT /api/security_ai_assistant/current_user/conversations/{id}
PUT /s/{space_id}/api/security_ai_assistant/current_user/conversations/{id}

Refer to Spaces for more information.

Update an existing conversation using the conversation ID. This endpoint allows users to modify the details of an existing conversation.

Authentication

Path parameters

Request body

apiConfig object
category enum: The conversation category.; Values: assistant insights
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.
replacements map string to string: Replacements object used to anonymize/deanonymize messages
title string: The conversation title.
users object[]

Responses

Indicates a successful call. The conversation was updated 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 PUT 'http://localhost:5601/api/security_ai_assistant/current_user/conversations/abc123' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"title":"Updated Security Discussion","category":"insights","messages":[{"content":"Resolved.","role":"assistant","timestamp":"2023-10-31T12:30:00Z"}],"apiConfig":{"connectorId":"54321","actionTypeId":"09876"},"replacements":{},"excludeFromLastConversationStorage":true}'

Request

Request example

{
  "apiConfig": {
    "actionTypeId": "09876",
    "connectorId": "54321"
  },
  "category": "insights",
  "excludeFromLastConversationStorage": true,
  "messages": [
    {
      "content": "The issue was resolved.",
      "role": "assistant",
      "timestamp": "2023-10-31T12:30:00Z"
    }
  ],
  "replacements": {},
  "title": "Updated Security Discussion"
}

Response

{
  "apiConfig": {
    "actionTypeId": "09876",
    "connectorId": "54321"
  },
  "category": "insights",
  "createdAt": "2023-10-31T12:01:00Z",
  "createdBy": {
    "id": "user1",
    "name": "John Doe"
  },
  "excludeFromLastConversationStorage": true,
  "id": "abc123",
  "messages": [
    {
      "content": "The issue was resolved.",
      "role": "assistant",
      "timestamp": "2023-10-31T12:30:00Z"
    }
  ],
  "namespace": "default",
  "replacements": {},
  "title": "Updated Security Discussion",
  "updatedAt": "2023-10-31T12:31:00Z",
  "users": [
    {
      "id": "user1",
      "name": "John Doe"
    }
  ]
}

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

Authentication

Path parameters

Request body { }

Responses

Request body