Skip to main content
GET
/
threads
/
{thread_id}
/
messages
cURL
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>",
      "created_at": 123,
      "thread_id": "<string>",
      "incomplete_details": {},
      "completed_at": 123,
      "incomplete_at": 123,
      "content": [
        {
          "image_file": {
            "file_id": "<string>",
            "detail": "auto"
          }
        }
      ],
      "assistant_id": "<string>",
      "run_id": "<string>",
      "attachments": [
        {
          "file_id": "<string>",
          "tools": [
            {}
          ]
        }
      ],
      "metadata": {}
    }
  ],
  "first_id": "msg_abc123",
  "last_id": "msg_abc123",
  "has_more": false
}

Documentation Index

Fetch the complete documentation index at: https://portkey-docs-migration-04-ai-tools.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

OK

​
object
string
required
Example:

"list"

​
data
The message object · object[]
required
​
first_id
string
required
Example:

"msg_abc123"

​
last_id
string
required
Example:

"msg_abc123"

​
has_more
boolean
required
Example:

false