Query parameters

• fields array[string]

  A list of fields to include in the response. If omitted, all fields are returned.

• filter string

  A search query to filter the conversations. Can match against titles, messages, or other conversation attributes.

• sort_field string

  The field by which to sort the results. Valid fields are created_at, title, and updated_at.

  Values are created_at, title, or updated_at.

• sort_order string

  The order in which to sort the results. Can be either asc for ascending or desc for descending.

  Values are asc or desc.

• page integer

  The page number of the results to retrieve. Default is 1.

  Minimum value is 1. Default value is 1.

• per_page integer

  The number of conversations to return per page. Default is 20.

  Minimum value is 0. Default value is 20.

Responses

• 200 application/json

  Successful response, returns a paginated list of conversations matching the specified criteria.

  Hide response attributes Show response attributes object

  • data array[object] Required

    A list of conversations.

    Hide data attributes Show data 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.

    • excludeFromLastConversationStorage boolean

      Exclude from last conversation storage.

    • id string(nonempty) Required

      The ID of the anonymization field.

      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

        Metadata

        Hide metadata attribute Show metadata attribute object

        • contentReferences object

          Data referred to by the message content.

      • reader object

        Message content.

        Additional properties are allowed.

      • role string Required

        Message role.

        Values are system, user, or assistant.

      • timestamp string(nonempty) Required

        Timestamp when the anonymization field was initially created.

        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

        How confident you are about this being a correct and useful learning.

        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)

        Timestamp when the anonymization field was initially created.

        Minimum length is 1.

    • timestamp string(nonempty)

      Timestamp when the anonymization field was initially created.

      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.

  • page integer Required

    The current page of the results.

  • perPage integer Required

    The number of results returned per page.

  • total integer Required

    The total number of conversations matching the filter criteria.

• 400 application/json

  Generic Error. The request could not be processed due to an invalid query parameter or other issue.

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode number