Thread API

Threads serve as conversation containers that store Messages exchanged between a user and an Assistant, maintaining context and continuity across interactions.

This page provides API schemas for the following methods:

After each API schema, you'll find a short example demonstrating how to correctly call the described method in code using the OpenAI SDK.

Note that the method names in the API schema and the SDK often differ. Accordingly, when calling these methods via the REST API, you should use the names from the API schema, while for calls through the OpenAI SDK, use the names from the examples.

API Schemas

Create a Thread

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

thread = client.beta.threads.create(
  messages=[
    {
      "role": "user",
      "content": "Create 3 data visualizations based on the trends in this file.",
      "attachments": [
        {
          "file_id": file.id,
          "tools": [{"type": "code_interpreter"}]
        }
      ]
    }
  ]
)

Retrieve information about a specific Thread by its ID

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

Modify a specific Thread by its ID

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

Delete a specific Thread by its ID

Python + OpenAI SDK Example:

from openai import OpenAI
client = OpenAI()

response = client.beta.threads.delete("thread_abc123")
print(response)

PreviousAssistant API NextMessage API

Last updated 2 months ago

Was this helpful?

POST /threads HTTP/1.1 Host: api.aimlapi.com Authorization: Bearer <YOUR_AIMLAPI_KEY> Content-Type: application/json Accept: */* Content-Length: 432 { "messages": [ { "role": "user", "content": "text", "attachments": [ { "file_id": "text", "tools": [ { "type": "code_interpreter" } ] } ], "metadata": { "ANY_ADDITIONAL_PROPERTY": "text" } } ], "metadata": { "ANY_ADDITIONAL_PROPERTY": "text" }, "tool_resources": { "code_interpreter": { "file_ids": [] }, "file_search": { "vector_store_ids": [ "text" ], "vector_stores": [ { "chunking_strategy": { "type": "auto" }, "file_ids": [ "text" ], "metadata": { "ANY_ADDITIONAL_PROPERTY": "text" } } ] } } }

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