POST
/
threads

Authorizations

x-portkey-api-key
string
headerrequired
x-portkey-virtual-key
string
headerrequired

Body

application/json
messages
object[]

A list of messages to start the thread with.

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.

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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

Response

200 - application/json

Represents a thread that contains messages.

id
string
required

The identifier, which can be referenced in API endpoints.

object
enum<string>
required

The object type, which is always thread.

Available options:
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.

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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

Was this page helpful?

Delete AssistantRetrieve Thread