Delete a conversation

View as Markdown
DELETE /api/security_ai_assistant/current_user/conversations/{id}
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Delete an existing conversation using the conversation ID. This endpoint allows users to permanently delete a conversation.

Path parameters

  • id string(nonempty) Required

    The conversation's id value.

    Minimum length is 1.

Responses

  • 200 application/json

    Indicates a successful call. The conversation was deleted 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.

      AI assistant conversation message.

      Hide messages attributes Show messages attributes object
      • 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.

      • 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

      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.

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode number
DELETE /api/security_ai_assistant/current_user/conversations/{id} 
curl \ --request DELETE 'https://localhost:5601/api/security_ai_assistant/current_user/conversations/abc123' \ --header "Authorization: $API_KEY"
Response examples (200) 
{ "id": "abc123", "title": "Deleted Security Discussion", "users": [ { "id": "user1", "name": "John Doe" } ], "category": "assistant", "messages": [ { "role": "system", "content": "The conversation has been deleted.", "timestamp": "2023-10-31T12:35:00Z" } ], "apiConfig": { "connectorId": "12345", "actionTypeId": "67890" }, "createdAt": "2023-10-31T12:01:00Z", "updatedAt": "2023-10-31T12:01:00Z", "replacements": {}, "excludeFromLastConversationStorage": false }