API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Messages

Create Message

POST/messages

List Messages

GET/messages

Update Message

PUT/messages/{message_id}

Get Message

GET/messages/{message_id}

List Messages Paginated

GET/messages/paginated

ModelsExpand Collapse

DataContent object { author, data, style, type }

author: MessageAuthor

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

One of the following:

"user"

"agent"

data: map[unknown]

The contents of the data message.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "data"

The type of the message, in this case data.

MessageAuthor = "user" or "agent"

One of the following:

"user"

"agent"

MessageStyle = "static" or "active"

One of the following:

"static"

"active"

ReasoningContent object { author, summary, content, 2 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

summary: array of string

A list of short reasoning summaries

content: optional array of string

The reasoning content or chain-of-thought text

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "reasoning"

The type of the message, in this case reasoning.

TaskMessage object { content, task_id, id, 3 more }

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

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

One of the following:

TextContent object { author, content, attachments, 3 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: string

The contents of the text message.

attachments: optional array of object { file_id, name, size, type }

Optional list of file attachments with structured metadata.

file_id: string

The unique ID of the attached file

name: string

The name of the file

size: number

The size of the file in bytes

type: string

The MIME type or content type of the file

format: optional TextFormat

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

One of the following:

"markdown"

"plain"

"code"

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "text"

The type of the message, in this case text.

ReasoningContent object { author, summary, content, 2 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

summary: array of string

A list of short reasoning summaries

content: optional array of string

The reasoning content or chain-of-thought text

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "reasoning"

The type of the message, in this case reasoning.

DataContent object { author, data, style, type }

author: MessageAuthor

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

One of the following:

"user"

"agent"

data: map[unknown]

The contents of the data message.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "data"

The type of the message, in this case data.

ToolRequestContent object { arguments, author, name, 3 more }

arguments: map[unknown]

The arguments to the tool.

author: MessageAuthor

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

One of the following:

"user"

"agent"

name: string

The name of the tool that is being requested.

tool_call_id: string

The ID of the tool call that is being requested.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent object { author, content, name, 4 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: unknown

The result of the tool.

name: string

The name of the tool that is being responded to.

tool_call_id: string

The ID of the tool call that is being responded to.

is_error: optional boolean

Whether the tool call resulted in an error. None when the harness does not report a status.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_response"

The type of the message, in this case tool_response.

task_id: string

ID of the task this message belongs to

id: optional string

The task message’s unique id

created_at: optional string

The timestamp when the message was created

formatdate-time

streaming_status: optional "IN_PROGRESS" or "DONE"

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: optional string

The timestamp when the message was last updated

formatdate-time

TextContent object { author, content, attachments, 3 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: string

The contents of the text message.

attachments: optional array of object { file_id, name, size, type }

Optional list of file attachments with structured metadata.

file_id: string

The unique ID of the attached file

name: string

The name of the file

size: number

The size of the file in bytes

type: string

The MIME type or content type of the file

format: optional TextFormat

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

One of the following:

"markdown"

"plain"

"code"

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "text"

The type of the message, in this case text.

TextFormat = "markdown" or "plain" or "code"

One of the following:

"markdown"

"plain"

"code"

ToolRequestContent object { arguments, author, name, 3 more }

arguments: map[unknown]

The arguments to the tool.

author: MessageAuthor

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

One of the following:

"user"

"agent"

name: string

The name of the tool that is being requested.

tool_call_id: string

The ID of the tool call that is being requested.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent object { author, content, name, 4 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: unknown

The result of the tool.

name: string

The name of the tool that is being responded to.

tool_call_id: string

The ID of the tool call that is being responded to.

is_error: optional boolean

Whether the tool call resulted in an error. None when the harness does not report a status.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_response"

The type of the message, in this case tool_response.

MessageListResponse = array of TaskMessage { content, task_id, id, 3 more }

content: TaskMessageContent

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

One of the following:

TextContent object { author, content, attachments, 3 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: string

The contents of the text message.

attachments: optional array of object { file_id, name, size, type }

Optional list of file attachments with structured metadata.

file_id: string

The unique ID of the attached file

name: string

The name of the file

size: number

The size of the file in bytes

type: string

The MIME type or content type of the file

format: optional TextFormat

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

One of the following:

"markdown"

"plain"

"code"

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "text"

The type of the message, in this case text.

ReasoningContent object { author, summary, content, 2 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

summary: array of string

A list of short reasoning summaries

content: optional array of string

The reasoning content or chain-of-thought text

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "reasoning"

The type of the message, in this case reasoning.

DataContent object { author, data, style, type }

author: MessageAuthor

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

One of the following:

"user"

"agent"

data: map[unknown]

The contents of the data message.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "data"

The type of the message, in this case data.

ToolRequestContent object { arguments, author, name, 3 more }

arguments: map[unknown]

The arguments to the tool.

author: MessageAuthor

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

One of the following:

"user"

"agent"

name: string

The name of the tool that is being requested.

tool_call_id: string

The ID of the tool call that is being requested.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent object { author, content, name, 4 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: unknown

The result of the tool.

name: string

The name of the tool that is being responded to.

tool_call_id: string

The ID of the tool call that is being responded to.

is_error: optional boolean

Whether the tool call resulted in an error. None when the harness does not report a status.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_response"

The type of the message, in this case tool_response.

task_id: string

ID of the task this message belongs to

id: optional string

The task message’s unique id

created_at: optional string

The timestamp when the message was created

formatdate-time

streaming_status: optional "IN_PROGRESS" or "DONE"

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: optional string

The timestamp when the message was last updated

formatdate-time

MessageListPaginatedResponse object { data, has_more, next_cursor }

Response with cursor pagination metadata.

data: array of TaskMessage { content, task_id, id, 3 more }

List of messages

content: TaskMessageContent

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

One of the following:

TextContent object { author, content, attachments, 3 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: string

The contents of the text message.

attachments: optional array of object { file_id, name, size, type }

Optional list of file attachments with structured metadata.

file_id: string

The unique ID of the attached file

name: string

The name of the file

size: number

The size of the file in bytes

type: string

The MIME type or content type of the file

format: optional TextFormat

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

One of the following:

"markdown"

"plain"

"code"

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "text"

The type of the message, in this case text.

ReasoningContent object { author, summary, content, 2 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

summary: array of string

A list of short reasoning summaries

content: optional array of string

The reasoning content or chain-of-thought text

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "reasoning"

The type of the message, in this case reasoning.

DataContent object { author, data, style, type }

author: MessageAuthor

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

One of the following:

"user"

"agent"

data: map[unknown]

The contents of the data message.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "data"

The type of the message, in this case data.

ToolRequestContent object { arguments, author, name, 3 more }

arguments: map[unknown]

The arguments to the tool.

author: MessageAuthor

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

One of the following:

"user"

"agent"

name: string

The name of the tool that is being requested.

tool_call_id: string

The ID of the tool call that is being requested.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent object { author, content, name, 4 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: unknown

The result of the tool.

name: string

The name of the tool that is being responded to.

tool_call_id: string

The ID of the tool call that is being responded to.

is_error: optional boolean

Whether the tool call resulted in an error. None when the harness does not report a status.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_response"

The type of the message, in this case tool_response.

task_id: string

ID of the task this message belongs to

id: optional string

The task message’s unique id

created_at: optional string

The timestamp when the message was created

formatdate-time

streaming_status: optional "IN_PROGRESS" or "DONE"

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: optional string

The timestamp when the message was last updated

formatdate-time

has_more: optional boolean

Whether there are more messages to fetch

next_cursor: optional string

Cursor for fetching the next page of older messages

MessagesBatch

Batch Update Messages

PUT/messages/batch

Batch Create Messages

POST/messages/batch

ModelsExpand Collapse

BatchUpdateResponse = array of TaskMessage { content, task_id, id, 3 more }

content: TaskMessageContent

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

One of the following:

TextContent object { author, content, attachments, 3 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: string

The contents of the text message.

attachments: optional array of object { file_id, name, size, type }

Optional list of file attachments with structured metadata.

file_id: string

The unique ID of the attached file

name: string

The name of the file

size: number

The size of the file in bytes

type: string

The MIME type or content type of the file

format: optional TextFormat

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

One of the following:

"markdown"

"plain"

"code"

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "text"

The type of the message, in this case text.

ReasoningContent object { author, summary, content, 2 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

summary: array of string

A list of short reasoning summaries

content: optional array of string

The reasoning content or chain-of-thought text

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "reasoning"

The type of the message, in this case reasoning.

DataContent object { author, data, style, type }

author: MessageAuthor

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

One of the following:

"user"

"agent"

data: map[unknown]

The contents of the data message.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "data"

The type of the message, in this case data.

ToolRequestContent object { arguments, author, name, 3 more }

arguments: map[unknown]

The arguments to the tool.

author: MessageAuthor

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

One of the following:

"user"

"agent"

name: string

The name of the tool that is being requested.

tool_call_id: string

The ID of the tool call that is being requested.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent object { author, content, name, 4 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: unknown

The result of the tool.

name: string

The name of the tool that is being responded to.

tool_call_id: string

The ID of the tool call that is being responded to.

is_error: optional boolean

Whether the tool call resulted in an error. None when the harness does not report a status.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_response"

The type of the message, in this case tool_response.

task_id: string

ID of the task this message belongs to

id: optional string

The task message’s unique id

created_at: optional string

The timestamp when the message was created

formatdate-time

streaming_status: optional "IN_PROGRESS" or "DONE"

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: optional string

The timestamp when the message was last updated

formatdate-time

BatchCreateResponse = array of TaskMessage { content, task_id, id, 3 more }

content: TaskMessageContent

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

One of the following:

TextContent object { author, content, attachments, 3 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: string

The contents of the text message.

attachments: optional array of object { file_id, name, size, type }

Optional list of file attachments with structured metadata.

file_id: string

The unique ID of the attached file

name: string

The name of the file

size: number

The size of the file in bytes

type: string

The MIME type or content type of the file

format: optional TextFormat

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

One of the following:

"markdown"

"plain"

"code"

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "text"

The type of the message, in this case text.

ReasoningContent object { author, summary, content, 2 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

summary: array of string

A list of short reasoning summaries

content: optional array of string

The reasoning content or chain-of-thought text

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "reasoning"

The type of the message, in this case reasoning.

DataContent object { author, data, style, type }

author: MessageAuthor

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

One of the following:

"user"

"agent"

data: map[unknown]

The contents of the data message.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "data"

The type of the message, in this case data.

ToolRequestContent object { arguments, author, name, 3 more }

arguments: map[unknown]

The arguments to the tool.

author: MessageAuthor

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

One of the following:

"user"

"agent"

name: string

The name of the tool that is being requested.

tool_call_id: string

The ID of the tool call that is being requested.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent object { author, content, name, 4 more }

author: MessageAuthor

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

One of the following:

"user"

"agent"

content: unknown

The result of the tool.

name: string

The name of the tool that is being responded to.

tool_call_id: string

The ID of the tool call that is being responded to.

is_error: optional boolean

Whether the tool call resulted in an error. None when the harness does not report a status.

style: optional MessageStyle

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

One of the following:

"static"

"active"

type: optional "tool_response"

The type of the message, in this case tool_response.

task_id: string

ID of the task this message belongs to

id: optional string

The task message’s unique id

created_at: optional string

The timestamp when the message was created

formatdate-time

streaming_status: optional "IN_PROGRESS" or "DONE"

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: optional string

The timestamp when the message was last updated

formatdate-time