Sign in

v6

latestSwagger 2.02026-07-1340109191.2 KB

Gets a list of messages that exist on a thread.

get/threads/{threadId}/messages

Path parameters

threadIdstring required

The ID of the thread to list messages from.

Query parameters

runIdstring

Filter messages by the run ID that generated them.

limitinteger

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.

afterstring

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.

beforestring

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.

Response

The requested list of messages.

object'list' required

The object type, which is always list.

first_idstring required

The first ID represented in this list.

last_idstring required

The last ID represented in this list.

has_moreboolean required

A value indicating whether there are additional values available not captured in this list.