Messages

API Reference

List all messages in a thread.

Returns a list of messages within a thread, allowing users to view the conversation flow.

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

Path parameters

threadId*string

Query parameters

Response

200

Body

application/json

id*string

assistant_id*nullable string

attachments*nullable array of MessageAttachmentDTO (object)

completed_at*nullable number

content*array of MessageContentDTO (any of)

created_at*number

incomplete_at*nullable number

incomplete_details*MessageIncompleteDetailsDTO (object)

metadatanullable any

object*enum

thread.message

role*any of

enumenum

run_id*nullable string

status*any of

enumenumenum

thread_id*string

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "text",
    "assistant_id": "text",
    "attachments": [
      {
        "file_id": "text",
        "tools": []
      }
    ],
    "completed_at": 0,
    "content": [
      {
        "text": {
          "annotations": [],
          "value": "text"
        },
        "type": "text"
      }
    ],
    "created_at": 0,
    "incomplete_at": 0,
    "incomplete_details": {
      "reason": "content_filter"
    },
    "object": "thread.message",
    "role": "user",
    "run_id": "text",
    "status": "in_progress",
    "thread_id": "text"
  }
]

Create a new message in a thread.

Creates a new message within a thread, contributing to the conversation.

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

Path parameters

threadId*string

Body

application/json

role*string

content*string

metadataobject

Response

201

Body

application/json

id*string

assistant_id*nullable string

attachments*nullable array of MessageAttachmentDTO (object)

completed_at*nullable number

content*array of MessageContentDTO (any of)

created_at*number

incomplete_at*nullable number

incomplete_details*MessageIncompleteDetailsDTO (object)

metadatanullable any

object*enum

thread.message

role*any of

enumenum

run_id*nullable string

status*any of

enumenumenum

thread_id*string

Request

JavaScriptCurlPython

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

Response

201

{
  "id": "text",
  "assistant_id": "text",
  "attachments": [
    {
      "file_id": "text",
      "tools": []
    }
  ],
  "completed_at": 0,
  "content": [
    {
      "text": {
        "annotations": [],
        "value": "text"
      },
      "type": "text"
    }
  ],
  "created_at": 0,
  "incomplete_at": 0,
  "incomplete_details": {
    "reason": "content_filter"
  },
  "object": "thread.message",
  "role": "user",
  "run_id": "text",
  "status": "in_progress",
  "thread_id": "text"
}

Get details of a specific message.

Retrieves a single message from a thread by its ID.

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

Path parameters

threadId*string

messageId*string

Response

200

Body

application/json

id*string

assistant_id*nullable string

attachments*nullable array of MessageAttachmentDTO (object)

completed_at*nullable number

content*array of MessageContentDTO (any of)

created_at*number

incomplete_at*nullable number

incomplete_details*MessageIncompleteDetailsDTO (object)

metadatanullable any

object*enum

thread.message

role*any of

enumenum

run_id*nullable string

status*any of

enumenumenum

thread_id*string

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "assistant_id": "text",
  "attachments": [
    {
      "file_id": "text",
      "tools": []
    }
  ],
  "completed_at": 0,
  "content": [
    {
      "text": {
        "annotations": [],
        "value": "text"
      },
      "type": "text"
    }
  ],
  "created_at": 0,
  "incomplete_at": 0,
  "incomplete_details": {
    "reason": "content_filter"
  },
  "object": "thread.message",
  "role": "user",
  "run_id": "text",
  "status": "in_progress",
  "thread_id": "text"
}

Update a message in a thread.

Updates an existing message in a thread.

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

Path parameters

threadId*string

messageId*string

Body

application/json

metadataobject

Response

200

Body

application/json

id*string

assistant_id*nullable string

attachments*nullable array of MessageAttachmentDTO (object)

completed_at*nullable number

content*array of MessageContentDTO (any of)

created_at*number

incomplete_at*nullable number

incomplete_details*MessageIncompleteDetailsDTO (object)

metadatanullable any

object*enum

thread.message

role*any of

enumenum

run_id*nullable string

status*any of

enumenumenum

thread_id*string

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "assistant_id": "text",
  "attachments": [
    {
      "file_id": "text",
      "tools": []
    }
  ],
  "completed_at": 0,
  "content": [
    {
      "text": {
        "annotations": [],
        "value": "text"
      },
      "type": "text"
    }
  ],
  "created_at": 0,
  "incomplete_at": 0,
  "incomplete_details": {
    "reason": "content_filter"
  },
  "object": "thread.message",
  "role": "user",
  "run_id": "text",
  "status": "in_progress",
  "thread_id": "text"
}