Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Voice & Audio Production API reference
API Dashboard
Try ChatGPT
API Reference
Beta
Threads
Messages

List messages

beta.threads.messages.list(thread_id, **kwargs) -> CursorPage<Message { id, assistant_id, attachments, 11 more } >
GET/threads/{thread_id}/messages

Returns a list of messages for a given thread.

ParametersExpand Collapse
thread_id: String
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.

limit: Integer

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

order: :asc | :desc

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

run_id: String

Filter messages by the run ID that generated them.

ReturnsExpand Collapse
class Message { id, assistant_id, attachments, 11 more }

Represents a message within a thread.

id: String

The identifier, which can be referenced in API endpoints.

assistant_id: String

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

attachments: Array[Attachment{ file_id, tools}]

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

completed_at: Integer

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

formatunixtime
content: Array[MessageContent]

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

created_at: Integer

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

formatunixtime
incomplete_at: Integer

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

formatunixtime
incomplete_details: IncompleteDetails{ reason}

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

metadata: Metadata

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

object: :"thread.message"

The object type, which is always thread.message.

role: :user | :assistant

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

run_id: String

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.

status: :in_progress | :incomplete | :completed

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

thread_id: String

The thread ID that this message belongs to.

List messages

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

page = openai.beta.threads.messages.list("thread_id")

puts(page)
{
  "object": "list",
  "data": [
    {
      "id": "msg_abc123",
      "object": "thread.message",
      "created_at": 1699016383,
      "assistant_id": null,
      "thread_id": "thread_abc123",
      "run_id": null,
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": {
            "value": "How does AI work? Explain it in simple terms.",
            "annotations": []
          }
        }
      ],
      "attachments": [],
      "metadata": {}
    },
    {
      "id": "msg_abc456",
      "object": "thread.message",
      "created_at": 1699016383,
      "assistant_id": null,
      "thread_id": "thread_abc123",
      "run_id": null,
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": {
            "value": "Hello, what is AI?",
            "annotations": []
          }
        }
      ],
      "attachments": [],
      "metadata": {}
    }
  ],
  "first_id": "msg_abc123",
  "last_id": "msg_abc456",
  "has_more": false
}
Returns Examples
{
  "object": "list",
  "data": [
    {
      "id": "msg_abc123",
      "object": "thread.message",
      "created_at": 1699016383,
      "assistant_id": null,
      "thread_id": "thread_abc123",
      "run_id": null,
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": {
            "value": "How does AI work? Explain it in simple terms.",
            "annotations": []
          }
        }
      ],
      "attachments": [],
      "metadata": {}
    },
    {
      "id": "msg_abc456",
      "object": "thread.message",
      "created_at": 1699016383,
      "assistant_id": null,
      "thread_id": "thread_abc123",
      "run_id": null,
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": {
            "value": "Hello, what is AI?",
            "annotations": []
          }
        }
      ],
      "attachments": [],
      "metadata": {}
    }
  ],
  "first_id": "msg_abc123",
  "last_id": "msg_abc456",
  "has_more": false
}