Managing Assistants & Threads

Overview

Threads and Messages represent a conversation session between an Assistant and a user. There is no limit to the number of Messages you can store in a Thread. When the size of the Messages exceeds the model's context window, the Thread will smartly truncate messages before fully dropping the least important ones.

API Reference

Delete an assistant.

Deletes an assistant, removing it from the system.

DELETEhttps://api.aimlapi.com/assistants/{assistantId}

Path parameters

assistantId*string

Response

200

Body

application/json

id*string

object*enum

assistant.deleted

deleted*boolean

Request

JavaScriptCurlPython

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

Response

200

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

Create a new assistant.

Creates a new AI assistant, configuring it to perform tasks based on predefined models and settings.

POSThttps://api.aimlapi.com/assistants

Body

application/json

name*string

description*string

model*string

instructionsstring

metadataobject

Response

201

Body

application/json

id*string

created_at*number

description*nullable string

instructions*nullable string

metadatanullable any

model*string

name*nullable string

object*enum

assistant

tools*array of AssistantTool (any)

response_formatany of

objectobjectnullable any

temperaturenullable number

tool_resourcesThreadToolResources (any)

top_pnullable number

Request

JavaScriptCurlPython

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

Response

201

{
  "id": "text",
  "created_at": 0,
  "description": "text",
  "instructions": "text",
  "model": "text",
  "name": "text",
  "object": "assistant",
  "tools": [],
  "response_format": {
    "type": "json_schema",
    "json_schema": {}
  },
  "temperature": 0,
  "top_p": 0
}

List all available assistants.

Returns a list of AI assistants that are available, allowing users to view and manage their virtual assistants.

GEThttps://api.aimlapi.com/assistants

Query parameters

Response

200

Body

application/json

object*enum

list

data*array of AssistnatDTO (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "created_at": 0,
      "description": "text",
      "instructions": "text",
      "model": "text",
      "name": "text",
      "object": "assistant",
      "tools": [],
      "response_format": {
        "type": "json_schema",
        "json_schema": {}
      },
      "temperature": 0,
      "top_p": 0
    }
  ]
}

Get details of a specific assistant.

Retrieves information about a specific assistant, including its current configuration and status.

GEThttps://api.aimlapi.com/assistants/{assistantId}

Path parameters

assistantId*string

Response

200

Body

application/json

object*enum

list

data*array of AssistnatDTO (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "created_at": 0,
      "description": "text",
      "instructions": "text",
      "model": "text",
      "name": "text",
      "object": "assistant",
      "tools": [],
      "response_format": {
        "type": "json_schema",
        "json_schema": {}
      },
      "temperature": 0,
      "top_p": 0
    }
  ]
}

Update an assistant’s settings.

Updates the configuration or settings of an existing assistant.

POSThttps://api.aimlapi.com/assistants/{assistantId}

Path parameters

assistantId*string

Body

application/json

namestring

descriptionstring

modelstring

instructionsstring

metadataobject

Response

200

Body

application/json

id*string

created_at*number

description*nullable string

instructions*nullable string

metadatanullable any

model*string

name*nullable string

object*enum

assistant

tools*array of AssistantTool (any)

response_formatany of

objectobjectnullable any

temperaturenullable number

tool_resourcesThreadToolResources (any)

top_pnullable number

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "created_at": 0,
  "description": "text",
  "instructions": "text",
  "model": "text",
  "name": "text",
  "object": "assistant",
  "tools": [],
  "response_format": {
    "type": "json_schema",
    "json_schema": {}
  },
  "temperature": 0,
  "top_p": 0
}