Threads

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

API Reference

delete

/threads/{threadId}

Authorizations

Path parameters

threadIdobjectrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

post

/threads

Authorizations

Body

metadataobject · default: [object Object]

messagesobject[]required

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "metadata": {},
    "messages": [
      {
        "content": "text",
        "role": "user",
        "metadata": {}
      }
    ]
  }'

201

201

No body

get

/threads/{threadId}

Authorizations

Path parameters

threadIdobjectrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

post

/threads/{threadId}

Authorizations

Path parameters

threadIdstringrequired

Body

metadataobject · default: [object Object]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/threads/{threadId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "metadata": {}
  }'

201

201

No body

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