Threads

The Threads API is very useful for creating a chat-like experience with a relatively large message history

API Reference

DELETE/threads/{threadId}

Path parameters

threadId*object

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/threads/{threadId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

POST/threads

Body

application/json

messages*array of object

metadataobject

Response

201

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/threads', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "messages": [
        {
          "role": "user",
          "content": "text"
        }
      ]
    }),
});
const data = await response.json();

GET/threads/{threadId}

Path parameters

threadId*LlmThread.v1.GetThreadDTO (object)

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/threads/{threadId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

POST/threads/{threadId}

Path parameters

threadId*string

Body

application/json

metadataobject

Response

201

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/threads/{threadId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Example

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"}]
        }
      ]
    }
  ]
)