List Message

GET

threads

{thread_id}

messages

curl https://api.portkey.ai/v1/threads/thread_abc123/messages \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "OpenAI-Beta: assistants=v2"

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "thread.message",
      "created_at": 123,
      "thread_id": "<string>",
      "status": "in_progress",
      "incomplete_details": {
        "reason": "content_filter"
      },
      "completed_at": 123,
      "incomplete_at": 123,
      "role": "user",
      "content": [
        {
          "type": "image_file",
          "image_file": {
            "file_id": "<string>",
            "detail": "auto"
          }
        }
      ],
      "assistant_id": "<string>",
      "run_id": "<string>",
      "attachments": [
        {
          "file_id": "<string>",
          "tools": [
            {
              "type": "code_interpreter"
            }
          ]
        }
      ],
      "metadata": {}
    }
  ],
  "first_id": "msg_abc123",
  "last_id": "msg_abc123",
  "has_more": false
}

Authorizations

x-portkey-api-key

string

header

required

x-portkey-virtual-key

string

header

required

Path Parameters

thread_id

string

required

The ID of the thread the messages belong to.

Query Parameters

limit

integer

default:20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order

enum<string>

default:desc

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Available options:

asc,

desc

after

string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before

string

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

run_id

string

Filter messages by the run ID that generated them.

Response

200 - application/json

object

string

required

Example:

"list"

data

object[]

required

Represents a message within a thread.

data.id

string

required

The identifier, which can be referenced in API endpoints.

data.object

enum<string>

required

The object type, which is always thread.message.

Available options:

thread.message

data.created_at

integer

required

The Unix timestamp (in seconds) for when the message was created.

data.thread_id

string

required

The thread ID that this message belongs to.

data.status

enum<string>

required

The status of the message, which can be either in_progress, incomplete, or completed.

Available options:

in_progress,

incomplete,

completed

data.incomplete_details

object | null

required

On an incomplete message, details about why the message is incomplete.

data.completed_at

integer | null

required

The Unix timestamp (in seconds) for when the message was completed.

data.incomplete_at

integer | null

required

The Unix timestamp (in seconds) for when the message was marked as incomplete.

data.role

enum<string>

required

The entity that produced the message. One of user or assistant.

Available options:

user,

assistant

data.content

object[]

required

The content of the message in array of text and/or images.

References an image File in the content of a message.

data.assistant_id

string | null

required

If applicable, the ID of the assistant that authored this message.

data.run_id

string | null

required

The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.

data.attachments

object[] | null

required

A list of files attached to the message, and the tools they were added to.

data.metadata

object | null

required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

first_id

string

required

Example:

"msg_abc123"

last_id

string

required

Example:

"msg_abc123"

has_more

boolean

required

Example:

false

Was this page helpful?

Suggest edits Raise issue

Create Message Retrieve Message

curl https://api.portkey.ai/v1/threads/thread_abc123/messages \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "OpenAI-Beta: assistants=v2"

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "thread.message",
      "created_at": 123,
      "thread_id": "<string>",
      "status": "in_progress",
      "incomplete_details": {
        "reason": "content_filter"
      },
      "completed_at": 123,
      "incomplete_at": 123,
      "role": "user",
      "content": [
        {
          "type": "image_file",
          "image_file": {
            "file_id": "<string>",
            "detail": "auto"
          }
        }
      ],
      "assistant_id": "<string>",
      "run_id": "<string>",
      "attachments": [
        {
          "file_id": "<string>",
          "tools": [
            {
              "type": "code_interpreter"
            }
          ]
        }
      ],
      "metadata": {}
    }
  ],
  "first_id": "msg_abc123",
  "last_id": "msg_abc123",
  "has_more": false
}

API Reference

Chat Completions

Portkey Prompts

Embeddings

Images

Audio

Realtime

Other APIs

Completions

Moderations

Fine-tuning

Batch

Files

Assistants

Authorizations

Path Parameters

Query Parameters

Response