Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Threads, gRPC: MessageService.Get

Written by
Updated at December 17, 2024

Retrieve details of a specific message by its ID.

gRPC request

rpc Get (GetMessageRequest) returns (Message)

GetMessageRequest

{
  "thread_id": "string",
  "message_id": "string"
}

Request message for retrieving a message from a thread.

Field

Description

thread_id

string

Required field. ID of the thread that contains the message.

message_id

string

Required field. ID of the message to retrieve.

Message

{
  "id": "string",
  "thread_id": "string",
  "created_by": "string",
  "created_at": "google.protobuf.Timestamp",
  "author": {
    "id": "string",
    "role": "string"
  },
  "labels": "map<string, string>",
  "content": {
    "content": [
      {
        // Includes only one of the fields `text`
        "text": {
          "content": "string"
        }
        // end of the list of possible fields
      }
    ]
  },
  "status": "MessageStatus"
}

Field

Description

id

string

Unique identifier of the message.

thread_id

string

ID of the thread that this message belongs to.

created_by

string

Identifier of the subject who created this message.

created_at

google.protobuf.Timestamp

Timestamp representing when the message was created.

author

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

MessageContent

Content of the message.

status

enum MessageStatus

Status of the message.

  • MESSAGE_STATUS_UNSPECIFIED: Unspecified message status.
  • COMPLETED: Message was successfully created by a user or generated by an assistant.
  • TRUNCATED: Message generation was truncated due to reaching the maximum allowed number of tokens.
  • FILTERED_CONTENT: Message generation was stopped because potentially sensitive content was detected either in the prompt or in the generated response.

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[]

ContentPart

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

Text content of the message part.

Includes only one of the fields text.

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.
Previous
Create
Next
List