agent builder

List conversations

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/agent_builder/conversations</span></div>

Refer to Spaces for more information.

List all conversations for a user. Use the optional agent ID to filter conversations by a specific agent. To learn more about agent conversations, refer to the agent chat documentation.<br/><br/>[Required authorization] Route required privileges: agentBuilder:read.

get/api/agent_builder/conversations

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/agent_builder/conversations
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

agent_idstring

Optional agent ID to filter conversations by a specific agent.

pagenumber

Page number, 1-based.

per_pagenumber

Number of results per page. Maximum 1000.

sort_order'asc' | 'desc'

Sort direction for results, ordered by updated_at.

pinnedboolean

Filter to pinned (true) or unpinned (false) conversations. Omit to return all.

Response

Indicates a successful response

Changes

  • 6d4d52eff401Revision changes
    • warning

      for the query request parameter agent_id, the maxLength was set to 64

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

    • info

      added the new optional query request parameter pinned

    • info

      added the new optional query request parameter sort_order