List messages

Returns a list of messages for a given thread.

GET /threads/{thread_id}/messages

List messages

cURL

curl --request GET \
  --url https://api.openai.com/v1/threads/{thread_id}/messages \
  --header 'Authorization: Bearer <token>'

200

{
  "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

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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, starting 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

Show child attributes

first_id · string · required

Example:

"msg_abc123"

last_id · string · required

Example:

"msg_abc123"

has_more · boolean · required

Example:

false