Threads

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

API Reference

Delete a thread.

Deletes a thread, permanently removing the conversation.

DELETEhttps://api.aimlapi.com/threads/{threadId}

Path parameters

threadId*string

Response

200

Body

application/json

id*string

object*enum

thread.deleted

deleted*boolean

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "object": "thread.deleted",
  "deleted": false
}

Create a new conversation thread.

Creates a new thread, initiating a conversation or interaction.

POSThttps://api.aimlapi.com/threads

Body

application/json

messages*array of string

metadataobject

Response

200

Body

application/json

id*string

created_at*number

metadatanullable any

object*enum

thread

tool_resources*ToolResourcesDTO (object)

Request

JavaScriptCurlPython

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

Response

200

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

Get details of a specific thread.

Retrieves a single thread by its ID, providing access to its details and messages.

GEThttps://api.aimlapi.com/threads/{threadId}

Path parameters

threadId*string

Response

200

Body

application/json

id*string

created_at*number

metadatanullable any

object*enum

thread

tool_resources*ToolResourcesDTO (object)

Request

JavaScriptCurlPython

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

Response

200

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

Update a thread’s information.

Updates the information or context of an existing thread.

POSThttps://api.aimlapi.com/threads/{threadId}

Path parameters

threadId*string

Body

application/json

metadataobject

Response

200

Body

application/json

id*string

created_at*number

metadatanullable any

object*enum

thread

tool_resources*ToolResourcesDTO (object)

Request

JavaScriptCurlPython

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

Response

200

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

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