{
  "data": [
    {
      "task_id": "<string>",
      "content": {
        "author": "user",
        "content": "<string>",
        "type": "text",
        "style": "static",
        "format": "plain",
        "attachments": [
          {
            "file_id": "<string>",
            "name": "<string>",
            "size": 123,
            "type": "<string>"
          }
        ]
      },
      "id": "<string>",
      "streaming_status": "IN_PROGRESS",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": false
}

Messages

List Messages Paginated

List messages for a task with cursor-based pagination. This endpoint is designed for infinite scroll UIs where new messages may arrive while paginating through older ones. Args: task_id: The task ID to filter messages by limit: Maximum number of messages to return (default: 50) cursor: Opaque cursor string for pagination. Pass the `next_cursor` from a previous response to get the next page. direction: Pagination direction - "older" to get older messages (default), "newer" to get newer messages. Returns: PaginatedMessagesResponse with: - data: List of messages (newest first when direction="older") - next_cursor: Cursor for fetching the next page (null if no more pages) - has_more: Whether there are more messages to fetch Example: First request: GET /messages/paginated?task_id=xxx&limit=50 Next page: GET /messages/paginated?task_id=xxx&limit=50&cursor=<next_cursor>

GET

messages

paginated

{
  "data": [
    {
      "task_id": "<string>",
      "content": {
        "author": "user",
        "content": "<string>",
        "type": "text",
        "style": "static",
        "format": "plain",
        "attachments": [
          {
            "file_id": "<string>",
            "name": "<string>",
            "size": 123,
            "type": "<string>"
          }
        ]
      },
      "id": "<string>",
      "streaming_status": "IN_PROGRESS",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": false
}

Query Parameters

limit

integer

default:50

cursor

string | null

direction

enum<string>

default:older

Available options:

older,

newer

task_id

string

required

The task ID

Response

Successful Response

Response with cursor pagination metadata.

data

TaskMessage · object[]

required

List of messages

Show child attributes

data.task_id

string

required

ID of the task this message belongs to

data.content

TextContent · object

required

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

TextContent
ReasoningContent
DataContent
ToolRequestContent
ToolResponseContent

Show child attributes

data.content.author

enum<string>

required

The role of the messages author, in this case system, user, assistant, or tool.

Available options:

user,

agent

data.content.content

string

required

The contents of the text message.

data.content.type

string

default:text

The type of the message, in this case text.

Allowed value: "text"

data.content.style

enum<string>

default:static

The style of the message. This is used by the client to determine how to display the message.

Available options:

static,

active

data.content.format

enum<string>

default:plain

The format of the message. This is used by the client to determine how to display the message.

Available options:

markdown,

plain,

code

data.content.attachments

FileAttachment · object[] | null

Optional list of file attachments with structured metadata.

Show child attributes

data.content.attachments.file_id

string

required

The unique ID of the attached file

data.content.attachments.name

string

required

The name of the file

data.content.attachments.size

integer

required

The size of the file in bytes

data.content.attachments.type

string

required

The MIME type or content type of the file

data.id

string | null

The task message's unique id

data.streaming_status

enum<string> | null

Available options:

IN_PROGRESS,

DONE

data.created_at

string<date-time> | null

The timestamp when the message was created

data.updated_at

string<date-time> | null

The timestamp when the message was last updated

next_cursor

string | null

Cursor for fetching the next page of older messages

has_more

boolean

default:false

Whether there are more messages to fetch

Update Message List Spans

⌘I

Agents

Tasks

Messages

Spans

States

Events

Agent Task Tracker

Agent APIKeys

Deployment History

Schedules

List Messages Paginated

Query Parameters

Response