Retrieve a thread | OpenAI API (unofficial showcase)

1 parameter

thread_idstringrequired

The ID of the thread to retrieve.

2 status codes

200Returns the thread object with its ID, object type, creation timestamp, tool resources, and metadata.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always `thread`.

Allowed:thread

created_atintegerrequired

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

tool_resourcesobjectrequired

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.

metadataobjectrequired

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.

429Returned when the request is rejected because a rate limit was exceeded.

errorobjectrequired

Error handling

A 429 is returned when the request exceeds a rate limit. The thread_id path parameter identifies the thread to retrieve.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.threads.get({ threadId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "thread",
  "created_at": 1,
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "example_value"
      ]
    }
  }
}

Request

Response

Errors