Retrieve Thread

Retrieves a thread.

GEThttps://api.portkey.ai/v1/threads/{thread_id}

Path parameters

thread_id*string

The ID of the thread to retrieve.

Response

200

OK

Body

application/json

id*string

The identifier, which can be referenced in API endpoints.

object*enum

The object type, which is always thread.

thread

created_at*integer

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

tool_resources*nullable object

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*nullable object

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

{
  "id": "text",
  "object": "thread",
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "text"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "text"
      ]
    }
  }
}