Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
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
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
createdAfter
string<date-time> | null

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Example 2: Compute Timestamp from POSIX gettimeofday().

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

Example 4: Compute Timestamp from Java System.currentTimeMillis().

Example 5: Compute Timestamp from Java Instant.now().

Example 6: Compute Timestamp from current time in Python.

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

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

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

createdBefore
string<date-time> | null

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Example 2: Compute Timestamp from POSIX gettimeofday().

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

Example 4: Compute Timestamp from Java System.currentTimeMillis().

Example 5: Compute Timestamp from Java Instant.now().

Example 6: Compute Timestamp from current time in Python.

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

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

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

excludeBatchRuns
boolean | null
excludeUnusedPlaybooks
boolean | null
source
enum<string> | null
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,
CHAT_SOURCE_DATA_APP
hasThreadWarning
boolean | null
creatorMemberIds
string[]
sharedWithMe
boolean | null
excludeFeed
boolean | null
sources
enum<string>[]
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,
CHAT_SOURCE_DATA_APP
threadWarningTypes
enum<string>[]

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[]
connectorIds
integer<int32>[]

Response

Success

chats
Chat · object[]
totalCount
integer<int32>