Threads, REST: Thread.Create
Create a new thread.
HTTP request
POST https://rest-assistant.api.cloud.yandex.net/assistants/v1/threads
Body parameters
{
"folderId": "string",
"messages": [
{
"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
}
]
}
}
],
"name": "string",
"description": "string",
"defaultMessageAuthorId": "string",
"expirationConfig": {
"expirationPolicy": "string",
"ttlDays": "string"
},
"labels": "object"
}
Request message for creating a new thread.
|
Field |
Description |
|
folderId |
string Required field. |
|
messages[] |
List of messages to initialize the thread. |
|
name |
string Name of the thread. |
|
description |
string Description of the thread. |
|
defaultMessageAuthorId |
string Default user ID that will be used as the author for thread messages if no other author is specified. |
|
expirationConfig |
Expiration configuration for the thread. |
|
labels |
object (map<string, string>) Set of key-value pairs to label the thread. |
MessageData
Represents the data required to create or initialize a message in a thread.
This message is used, for example, to initialize a thread with some messages upon its creation.
|
Field |
Description |
|
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. |
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. |
ExpirationConfig
|
Field |
Description |
|
expirationPolicy |
enum (ExpirationPolicy)
|
|
ttlDays |
string (int64) |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"defaultMessageAuthorId": "string",
"createdBy": "string",
"createdAt": "string",
"updatedBy": "string",
"updatedAt": "string",
"expirationConfig": {
"expirationPolicy": "string",
"ttlDays": "string"
},
"expiresAt": "string",
"labels": "object"
}
|
Field |
Description |
|
id |
string Unique identifier of the thread. |
|
folderId |
string ID of the folder that the thread belongs to. |
|
name |
string Name of the thread. |
|
description |
string Description of the thread. |
|
defaultMessageAuthorId |
string Default user ID that will be used as the author for thread messages if no other author is specified. |
|
createdBy |
string Identifier of the subject who created this thread. |
|
createdAt |
string (date-time) Timestamp representing when the thread 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 |
|
updatedBy |
string Identifier of the subject who last updated this thread. |
|
updatedAt |
string (date-time) Timestamp representing the last time this thread was updated. 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 |
|
expirationConfig |
Configuration for the expiration of the thread, defining when and how the thread will expire. |
|
expiresAt |
string (date-time) Timestamp representing when the thread will expire. 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 |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the thread. |
ExpirationConfig
|
Field |
Description |
|
expirationPolicy |
enum (ExpirationPolicy)
|
|
ttlDays |
string (int64) |