Skip to main content
POST
Python (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
memberOnly
boolean

whether to return only the user's chats or all of the org's chats

searchTerm
string | null
limit
integer<int32> | null
offset
integer<int32> | null
creatorMemberId
string | null
sortBy
enum<string>
Available options:
CHAT_SORT_FIELD_UNKNOWN,
CHAT_SORT_FIELD_NAME,
CHAT_SORT_FIELD_CREATED_AT,
CHAT_SORT_FIELD_UPDATED_AT
sortDirection
enum<string>
Available options:
CHAT_SORT_DIRECTION_UNKNOWN,
CHAT_SORT_DIRECTION_ASC,
CHAT_SORT_DIRECTION_DESC
bookmarkedOnly
boolean | null

filter to only bookmarked chats

createdAfter
string<date-time> | null

filter chats created after this time

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

createdBefore
string<date-time> | null

filter chats created before this time

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

excludeBatchRuns
boolean | null

exclude chats created from template batch runs

excludeUnusedPlaybooks
boolean | null

exclude chats created from playbooks that have no user messages beyond the initial prompt

source
enum<string> | null

filter chats by source (single-select; superseded by sources when that is non-empty)

Available options:
CHAT_SOURCE_UNKNOWN,
CHAT_SOURCE_THREAD,
CHAT_SOURCE_PLAYBOOK,
CHAT_SOURCE_SLACK,
CHAT_SOURCE_FEED,
CHAT_SOURCE_TEAMS,
CHAT_SOURCE_SMS,
CHAT_SOURCE_MCP,
CHAT_SOURCE_SYSTEM
hasThreadWarning
boolean | null

When true (and thread_warning_types empty), only chats that have at least one thread_warning row of any type.

creatorMemberIds
string[]

Filter org chats to these creator member IDs (union). Ignored when empty. Supersedes creator_member_id when non-empty.

sharedWithMe
boolean | null
excludeFeed
boolean | null
sources
enum<string>[]

Filter chats by source (union). Ignored when empty. Supersedes the single source when non-empty.

Available options:
CHAT_SOURCE_UNKNOWN,
CHAT_SOURCE_THREAD,
CHAT_SOURCE_PLAYBOOK,
CHAT_SOURCE_SLACK,
CHAT_SOURCE_FEED,
CHAT_SOURCE_TEAMS,
CHAT_SOURCE_SMS,
CHAT_SOURCE_MCP,
CHAT_SOURCE_SYSTEM
threadWarningTypes
enum<string>[]

Filter to chats with at least one thread_warning of any of these types (union).

ThreadWarningType is the canonical set of thread warning types

Available options:
THREAD_WARNING_TYPE_UNSPECIFIED,
THREAD_WARNING_TYPE_MISSING_CONTEXT,
THREAD_WARNING_TYPE_ERROR_LOOP,
THREAD_WARNING_TYPE_EXCESSIVE_TOOL_CALLS,
THREAD_WARNING_TYPE_SLOW_QUERY,
THREAD_WARNING_TYPE_NO_RESULTS,
THREAD_WARNING_TYPE_USER_FRUSTRATION,
THREAD_WARNING_TYPE_POTENTIAL_HALLUCINATION,
THREAD_WARNING_TYPE_IGNORED_INSTRUCTION,
THREAD_WARNING_TYPE_USER_THUMBS_DOWN,
THREAD_WARNING_TYPE_NO_CONCLUSION,
THREAD_WARNING_TYPE_USER_THUMBS_UP,
THREAD_WARNING_TYPE_GOAL_ACHIEVED,
THREAD_WARNING_TYPE_USER_SATISFACTION
topicIds
string[]

Only chats tagged with at least one of these custom topics (verdict='tagged'). Ignored when empty.

connectorIds
integer<int32>[]

Filter chats that have any of these connector IDs in their paradigm options (union). Ignored when empty.

Response

Success

chats
Chat · object[]
totalCount
integer<int32>