API Reference

Beta

Threads

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create thread

Deprecated: The Assistants API is deprecated in favor of the Responses API

$ openai beta:threads create

POST/threads

Create a thread.

ParametersExpand Collapse

--message: optional array of object { content, role, attachments, metadata }

A list of messages to start the thread with.

--metadata: optional map[string]

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 object { code_interpreter, file_search }

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.

ReturnsExpand Collapse

thread: object { id, created_at, metadata, 2 more }

Represents a thread that contains messages.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

metadata: map[string]

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: "thread"

The object type, which is always thread.

tool_resources: object { code_interpreter, file_search }

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 object { file_ids }

file_ids: optional array of string

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 object { vector_store_ids }

vector_store_ids: optional array of string

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

Create thread

CLI Tool

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

openai beta:threads create \
  --api-key 'My API Key'

200 example

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "string"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  }
}

Returns Examples

200 example

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "string"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  }
}