Threads, REST: Message.List
List messages in a specific thread.
By default, messages are listed in reverse chronological order, i.e., from the newest to the oldest.
HTTP request
GET https://rest-assistant.api.cloud.yandex.net/assistants/v1/messages
Query parameters
Request message for listing messages in a specific thread.
|
Field |
Description |
|
threadId |
string Required field. ID of the thread whose messages will be listed. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"threadId": "string",
"createdBy": "string",
"createdAt": "string",
"author": {
"id": "string",
"role": "string"
},
"labels": "object",
"content": {
"content": [
{
// Includes only one of the fields `text`
"text": {
"content": "string"
}
// end of the list of possible fields
}
]
},
"status": "string"
}
|
Field |
Description |
|
id |
string Unique identifier of the message. |
|
threadId |
string ID of the thread that this message belongs to. |
|
createdBy |
string Identifier of the subject who created this message. |
|
createdAt |
string (date-time) Timestamp representing when the message was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
author |
Author of the message, containing details about the message's creator. |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the message. |
|
content |
Content of the message. |
|
status |
enum (MessageStatus) Status of the message.
|
Author
Author of the message, containing details about the message's creator.
|
Field |
Description |
|
id |
string Unique identifier of the author. This could be either the user's ID or the assistant's ID, depending on the role. |
|
role |
string Role of the author, indicating whether the message was created by a "user" or an "assistant". |
MessageContent
Represents the content of a message, which can consist of multiple parts.
|
Field |
Description |
|
content[] |
A list of content parts that make up the message. |
ContentPart
ContentPart represents an individual part of the message content, which can be of various types.
|
Field |
Description |
|
text |
Text content of the message part. Includes only one of the fields Specifies the type of content that the part contains. |
Text
Text represents a textual content part of a message.
|
Field |
Description |
|
content |
string Text content of the message. |