Threads, REST: Thread.Get

Field

Description

threadId

string

Required field. ID of the thread to retrieve.

Field

Description

id

string

Unique identifier of the thread.

folderId

string

ID of the folder that the thread belongs to.

name

string

Name of the thread.

description

string

Description of the thread.

defaultMessageAuthorId

string

Default user ID that will be used as the author for thread messages if no other author is specified.

createdBy

string

Identifier of the subject who created this thread.

createdAt

string (date-time)

Timestamp representing when the thread was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedBy

string

Identifier of the subject who last updated this thread.

updatedAt

string (date-time)

Timestamp representing the last time this thread was updated.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

expirationConfig

ExpirationConfig

Configuration for the expiration of the thread, defining when and how the thread will expire.

expiresAt

string (date-time)

Timestamp representing when the thread will expire.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Set of key-value pairs that can be used to organize and categorize the thread.

tools[]

Tool

List of tools that are available for assistants to use in this thread.

Field

Description

expirationPolicy

enum (ExpirationPolicy)

• EXPIRATION_POLICY_UNSPECIFIED
• STATIC
• SINCE_LAST_ACTIVE

ttlDays

string (int64)

Field

Description

searchIndex

SearchIndexTool

SearchIndexTool tool that performs search across specified indexes.

Includes only one of the fields searchIndex, function.

function

FunctionTool

Function tool that can be invoked by the assistant.

Includes only one of the fields searchIndex, function.

Field

Description

searchIndexIds[]

string

A list of search index IDs that this tool will query. Currently, only a single index ID is supported.

maxNumResults

string (int64)

The maximum number of results to return from the search.
Fewer results may be returned if necessary to fit within the prompt's token limit.
This ensures that the combined prompt and search results do not exceed the token constraints.

rephraserOptions

RephraserOptions

Options for rephrasing user queries.
Used to rewrite the last user message for search,
incorporating context from the previous conversation.

Field

Description

rephraserUri

string

Required field. The ID of the model used to rephrase the last user message for search.

Field

Description

name

string

The name of the function.

description

string

A description of the function's purpose or behavior.

parameters

object

A JSON Schema that defines the expected parameters for the function.
The schema should describe the required fields, their types, and any constraints or default values.