⋙ List Messages

Returns a list of messages for a given thread.

msg.payload Properties

thread_id string

The ID of the thread the messages belong to.

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 string

Sort order by the created_at timestamp of the objects.

after string

A cursor for use in pagination.

before string

A cursor for use in pagination.

run_id string

Filter messages by the run ID that generated them.

⋙ Create Message

Create a message.

msg.payload Properties

thread_id string

The ID of the thread to create a message for.

role string

The role of the entity that is creating the message.

content string

The content of the message.

attachments array

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

metadata object

Set of 16 key-value pairs that can be attached to an object.

⋙ Delete Message

Deletes a message.

msg.payload Properties

thread_id string

The ID of the thread to which this message belongs.

message_id string

The ID of the message to delete.

⋙ Retrieve Message

Retrieve a message.

msg.payload Properties

thread_id string

The ID of the thread to which this message belongs.

message_id string

The ID of the message to retrieve.

⋙ Delete Message

Delete a message.

msg.payload Properties

thread_id string

The ID of the thread to which this message belongs.

message_id string

The ID of the thread to which this message belongs.

⋙ Modify Message

Modifies a message.

msg.payload Properties

thread_id string

The ID of the thread to which this message belongs.

message_id string

The ID of the message to modify.

metadata object

Set of 16 key-value pairs that can be attached to an object.