Skip to content

Create thread

Deprecated
beta.threads.create(ThreadCreateParams**kwargs) -> Thread
POST/threads

Create a thread.

ParametersExpand Collapse
messages: Optional[Iterable[Message]]

A list of messages to start the thread with.

content: Union[str, Iterable[MessageContentPartParam]]

The text contents of the message.

Accepts one of the following:
str

The text contents of the message.

An array of content parts with a defined type, each can be of type text or images can be passed with image_url or image_file. Image types are only supported on Vision-compatible models.

Accepts one of the following:
class ImageFileContentBlock: …

References an image File in the content of a message.

image_file: ImageFile
file_id: str

The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.

detail: Optional[Literal["auto", "low", "high"]]

Specifies the detail level of the image if specified by the user. low uses fewer tokens, you can opt in to high resolution using high.

Accepts one of the following:
"auto"
"low"
"high"
type: Literal["image_file"]

Always image_file.

class ImageURLContentBlock: …

References an image URL in the content of a message.

image_url: ImageURL
url: str

The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.

formaturi
detail: Optional[Literal["auto", "low", "high"]]

Specifies the detail level of the image. low uses fewer tokens, you can opt in to high resolution using high. Default value is auto

Accepts one of the following:
"auto"
"low"
"high"
type: Literal["image_url"]

The type of the content part.

class TextContentBlockParam: …

The text content that is part of a message.

text: str

Text content to be sent to the model

type: Literal["text"]

Always text.

role: Literal["user", "assistant"]

The role of the entity that is creating the message. Allowed values include:

  • user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.
  • assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.
Accepts one of the following:
"user"
"assistant"
attachments: Optional[Iterable[MessageAttachment]]

A list of files attached to the message, and the tools they should be added to.

file_id: Optional[str]

The ID of the file to attach to the message.

tools: Optional[Iterable[MessageAttachmentTool]]

The tools to add this file to.

Accepts one of the following:
class CodeInterpreterTool: …
type: Literal["code_interpreter"]

The type of tool being defined: code_interpreter

class MessageAttachmentToolFileSearch: …
type: Literal["file_search"]

The type of tool being defined: file_search

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.

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.

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[SequenceNotStr[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.

Accepts one of the following:
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.

Create thread

from openai import OpenAI
client = OpenAI()

empty_thread = client.beta.threads.create()
print(empty_thread)
{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699012949,
  "metadata": {},
  "tool_resources": {}
}

Create thread

from openai import OpenAI
client = OpenAI()

message_thread = client.beta.threads.create(
  messages=[
    {
      "role": "user",
      "content": "Hello, what is AI?"
    },
    {
      "role": "user",
      "content": "How does AI work? Explain it in simple terms."
    },
  ]
)

print(message_thread)
{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {},
  "tool_resources": {}
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "string"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  }
}