Create a thread.

POST /threads

Api key auth

application/json

Body

messages array[object]

A list of messages to start the thread with.
Hide messages attributes Show messages attributes object
- role string Required
  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.
  Values are user or assistant.
- content string | array[object] Required
  
  One of:
  Text content string Array of content parts array[object]
  
  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.
  
  At least 1 element.
  
  One of:
  MessageContentImageFileObject object MessageContentImageUrlObject object MessageRequestContentTextObject object
  
  References an image File in the content of a message.
  
  Hide attributes Show attributes
  
  type string Required
  
  Always image_file.
  
  Value is image_file.
  
  image_file object Required
  
  Hide image_file attributes Show image_file attributes object
  
  file_id string Required
  
  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 string
  
  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.
  
  Values are auto, low, or high. Default value is auto.
  
  References an image URL in the content of a message.
  
  Hide attributes Show attributes
  
  type string Required
  
  The type of the content part.
  
  Value is image_url.
  
  image_url object Required
  
  Hide image_url attributes Show image_url attributes object
  
  url string(uri) Required
  
  The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.
  
  detail string
  
  Specifies the detail level of the image. low uses fewer tokens, you can opt in to high resolution using high. Default value is auto
  
  Values are auto, low, or high. Default value is auto.
- attachments array[object] | null
  
  A list of files attached to the message, and the tools they should be added to.
  Hide attachments attributes Show attachments attributes object
  
  file_id string
  
  The ID of the file to attach to the message.
  
  tools array[object]
  
  The tools to add this file to.
  
  One of:
  AssistantToolsCode object AssistantToolsFileSearchTypeOnly object
  
  Hide attribute Show attribute
  
  type string Required
  
  The type of tool being defined: code_interpreter
  
  Value is code_interpreter.
- metadata object | null
  
  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.
  Hide metadata attribute Show metadata attribute object | null
  
  * string Additional properties
tool_resources object | null

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.
Hide tool_resources attributes Show tool_resources attributes object | null
- code_interpreter object
  Hide code_interpreter attribute Show code_interpreter attribute object
  
  file_ids array[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.
  
  Not more than 20 elements. Default value is [] (empty).
- file_search object
  
  One of:
  object-1 object object-2 object
  
  Hide attributes Show attributes
  
  vector_store_ids array[string] Required
  
  The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.
  
  Not more than 1 element.
  
  vector_stores array[object]
  
  A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.
  
  Not more than 1 element.
  
  Hide vector_stores attributes Show vector_stores attributes object
  
  file_ids array[string]
  
  A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.
  
  Not more than 10000 elements.
  
  chunking_strategy object
  
  The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.
  
  One of:
  Auto Chunking Strategy object Static Chunking Strategy object
  
  The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
  
  Hide attribute Show attribute
  
  type string Required
  
  Always auto.
  
  Value is auto.
  
  Hide attributes Show attributes
  
  type string Required
  
  Always static.
  
  Value is static.
  
  static object Required
  
  Additional properties are NOT allowed.
  
  Hide static attributes Show static attributes object
  
  max_chunk_size_tokens integer Required
  
  The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.
  
  Minimum value is 100, maximum value is 4096.
  
  chunk_overlap_tokens integer Required
  
  The number of tokens that overlap between chunks. The default value is 400.
  
  Note that the overlap must not exceed half of max_chunk_size_tokens.
  
  metadata object | null
  
  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.
  
  Hide metadata attribute Show metadata attribute object | null
  
  * string Additional properties
  
  Hide attributes Show attributes
  
  vector_store_ids array[string]
  
  The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.
  
  Not more than 1 element.
  
  vector_stores array[object] Required
  
  A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.
  
  Not more than 1 element.
  
  Hide vector_stores attributes Show vector_stores attributes object
  
  file_ids array[string]
  
  A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.
  
  Not more than 10000 elements.
  
  chunking_strategy object
  
  The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.
  
  One of:
  Auto Chunking Strategy object Static Chunking Strategy object
  
  The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
  
  Hide attribute Show attribute
  
  type string Required
  
  Always auto.
  
  Value is auto.
  
  Hide attributes Show attributes
  
  type string Required
  
  Always static.
  
  Value is static.
  
  static object Required
  
  Additional properties are NOT allowed.
  
  Hide static attributes Show static attributes object
  
  max_chunk_size_tokens integer Required
  
  The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.
  
  Minimum value is 100, maximum value is 4096.
  
  chunk_overlap_tokens integer Required
  
  The number of tokens that overlap between chunks. The default value is 400.
  
  Note that the overlap must not exceed half of max_chunk_size_tokens.
  
  metadata object | null
  
  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.
  
  Hide metadata attribute Show metadata attribute object | null
  
  * string Additional properties
metadata object | null

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.
Hide metadata attribute Show metadata attribute object | null
- * string Additional properties

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id string Required
  
  The identifier, which can be referenced in API endpoints.
- object string Required
  
  The object type, which is always thread.
  
  Value is thread.
- created_at integer Required
  
  The Unix timestamp (in seconds) for when the thread was created.
- tool_resources object | null Required
  
  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.
  
  Hide tool_resources attributes Show tool_resources attributes object | null
  
  code_interpreter object
  
  Hide code_interpreter attribute Show code_interpreter attribute object
  
  file_ids array[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.
  
  Not more than 20 elements. Default value is [] (empty).
  
  file_search object
  
  Hide file_search attribute Show file_search attribute object
  
  vector_store_ids array[string]
  
  The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.
  
  Not more than 1 element.
- metadata object | null Required
  
  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.
  
  Hide metadata attribute Show metadata attribute object | null
  
  * string Additional properties

POST /threads

curl \
 --request POST 'https://api.openai.com/v1/threads' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"messages":[{"role":"user","content":"string","attachments":[{"file_id":"string","tools":[{"type":"code_interpreter"}]}],"metadata":{"additionalProperty1":"string","additionalProperty2":"string"}}],"tool_resources":{"code_interpreter":{"file_ids":[]},"file_search":{"vector_store_ids":["string"],"vector_stores":[{"file_ids":["string"],"chunking_strategy":{"type":"auto"},"metadata":{"additionalProperty1":"string","additionalProperty2":"string"}}]}},"metadata":{"additionalProperty1":"string","additionalProperty2":"string"}}'

Request examples

{
  "messages": [
    {
      "role": "user",
      "content": "string",
      "attachments": [
        {
          "file_id": "string",
          "tools": [
            {
              "type": "code_interpreter"
            }
          ]
        }
      ],
      "metadata": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ],
      "vector_stores": [
        {
          "file_ids": [
            "string"
          ],
          "chunking_strategy": {
            "type": "auto"
          },
          "metadata": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          }
        }
      ]
    }
  },
  "metadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}

Response examples (200)

{
  "id": "string",
  "object": "thread",
  "created_at": 42,
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  },
  "metadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}

Create a thread.

Body

content string | array[object] Required

file_search object

chunking_strategy object

Responses