Skip to content
agentex-sdk
API Reference

Events

Get Event
client.events.retrieve(stringeventID, RequestOptionsoptions?): Event { id, agent_id, sequence_id, 3 more }
GET/events/{event_id}
List Events
client.events.list(EventListParams { agent_id, task_id, last_processed_event_id, limit } query, RequestOptionsoptions?): EventListResponse { id, agent_id, sequence_id, 3 more }
GET/events
ModelsExpand Collapse
Event { id, agent_id, sequence_id, 3 more }
id: string

The UUID of the event

agent_id: string

The UUID of the agent that the event belongs to

sequence_id: number

The sequence ID of the event

task_id: string

The UUID of the task that the event belongs to

content?: TaskMessageContent | null

The content of the event

One of the following:
TextContent { 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?: Array<Attachment> | null

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?: 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?: 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?: "text"

The type of the message, in this case text.

ReasoningContent { 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<string>

A list of short reasoning summaries

content?: Array<string> | null

The reasoning content or chain-of-thought text

style?: 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?: "reasoning"

The type of the message, in this case reasoning.

DataContent { 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: Record<string, unknown>

The contents of the data message.

style?: 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?: "data"

The type of the message, in this case data.

ToolRequestContent { arguments, author, name, 3 more }
arguments: Record<string, 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?: 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?: "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent { 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?: boolean | null

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

style?: 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?: "tool_response"

The type of the message, in this case tool_response.

created_at?: string | null

The timestamp of the event

formatdate-time
EventListResponse = Array<Event { id, agent_id, sequence_id, 3 more } >
id: string

The UUID of the event

agent_id: string

The UUID of the agent that the event belongs to

sequence_id: number

The sequence ID of the event

task_id: string

The UUID of the task that the event belongs to

content?: TaskMessageContent | null

The content of the event

One of the following:
TextContent { 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?: Array<Attachment> | null

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?: 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?: 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?: "text"

The type of the message, in this case text.

ReasoningContent { 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<string>

A list of short reasoning summaries

content?: Array<string> | null

The reasoning content or chain-of-thought text

style?: 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?: "reasoning"

The type of the message, in this case reasoning.

DataContent { 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: Record<string, unknown>

The contents of the data message.

style?: 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?: "data"

The type of the message, in this case data.

ToolRequestContent { arguments, author, name, 3 more }
arguments: Record<string, 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?: 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?: "tool_request"

The type of the message, in this case tool_request.

ToolResponseContent { 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?: boolean | null

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

style?: 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?: "tool_response"

The type of the message, in this case tool_response.

created_at?: string | null

The timestamp of the event

formatdate-time