Search
K
OpenAI API

Thread

object

Represents a thread that contains messages.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always thread.

Allowed values:thread

created_atintegerrequired

The Unix timestamp (in seconds) for when the thread was created.

tool_resourcesobjectrequired

A set of resources that are made available to the assistant’s tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Show Child Parameters
metadataobjectrequired

Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.

Example

ThreadStreamEvent

One Of
enabledboolean

Whether to enable input audio transcription.

eventstringrequired

Allowed values:thread.created

dataobjectrequired

Represents a thread that contains messages.

Show Child Parameters
Example

TranscriptionSegment

object
idintegerrequired

Unique identifier of the segment.

seekintegerrequired

Seek offset of the segment.

startnumber(float)required

Start time of the segment in seconds.

endnumber(float)required

End time of the segment in seconds.

textstringrequired

Text content of the segment.

tokensarray[integer]required

Array of token IDs for the text content.

temperaturenumber(float)required

Temperature parameter used for generating the segment.

avg_logprobnumber(float)required

Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

compression_rationumber(float)required

Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

no_speech_probnumber(float)required

Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

Example

TranscriptionWord

object
wordstringrequired

The text content of the word.

startnumber(float)required

Start time of the word in seconds.

endnumber(float)required

End time of the word in seconds.

Example

Thread Truncation Controls

object

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

typestringrequired

The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.

Allowed values:autolast_messages

last_messagesinteger

The number of most recent messages from the thread when constructing the context for the run.

>= 1

Example