Retrieve thread

Deprecated

beta.threads.retrieve() -> Thread

GET/threads/{thread_id}

Retrieves a thread.

ParametersExpand Collapse

thread_id: str

ReturnsExpand Collapse

class Thread: …

Represents a thread that contains messages.

id: str

The identifier, which can be referenced in API endpoints.

created_at: int

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

metadata: Optional[Metadata]

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.

object: Literal["thread"]

The object type, which is always thread.

tool_resources: Optional[ToolResources]

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.

code_interpreter: Optional[ToolResourcesCodeInterpreter]

file_ids: Optional[List[str]]

A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.

file_search: Optional[ToolResourcesFileSearch]

vector_store_ids: Optional[List[str]]

The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.

Retrieve thread

from openai import OpenAI
client = OpenAI()

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {},
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    }
  }
}

Returns Examples

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {},
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    }
  }
}