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

/assistants/{assistantId}

Authorizations

Path parameters

assistantIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.aimlapi.com/assistants/{assistantId}' \
  --header 'Authorization: Bearer JWT'

200

200

No body

post

/assistants

Authorizations

Body

namestringrequired

descriptionstringrequired

instructionsstring

modelstring · enumrequired

Options: mistralai/Mistral-7B-Instruct-v0.1, mistralai/Mistral-7B-Instruct-v0.2, mistralai/Mixtral-8x7B-Instruct-v0.1

metadataobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/assistants' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "instructions": "text",
    "model": "mistralai/Mistral-7B-Instruct-v0.1",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": null
    }
  }'

201

201

No body

get

/assistants

Authorizations

Query parameters

LlmAssistant.v1.GetAssistantsDTOobjectrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/assistants?LlmAssistant.v1.GetAssistantsDTO=%5Bobject+Object%5D' \
  --header 'Authorization: Bearer JWT'

200

200

No body

get

/assistants/{assistantId}

Authorizations

Path parameters

assistantIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/assistants/{assistantId}' \
  --header 'Authorization: Bearer JWT'

200

200

No body

post

/assistants/{assistantId}

Authorizations

Path parameters

assistantIdstringrequired

Body

all of

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/assistants/{assistantId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "instructions": "text",
    "model": "mistralai/Mistral-7B-Instruct-v0.1",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": null
    }
  }'

201

201

No body