Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.65 KB

MessageObject.md

File metadata and controls

54 lines (34 loc) · 2.65 KB

MessageObject

Represents a message within a thread.

Properties

Name Type Description Notes
id String The identifier, which can be referenced in API endpoints.
_object ObjectEnum The object type, which is always `thread.message`.
createdAt Integer The Unix timestamp (in seconds) for when the message was created.
threadId String The thread ID that this message belongs to.
status StatusEnum The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. [optional]
incompleteDetails MessageObjectIncompleteDetails [optional]
completedAt Integer The Unix timestamp (in seconds) for when the message was completed. [optional]
incompleteAt Integer The Unix timestamp (in seconds) for when the message was marked as incomplete. [optional]
role RoleEnum The entity that produced the message. One of `user` or `assistant`.
content List<MessageObjectContentInner> The content of the message in array of text and/or images.
assistantId String If applicable, the ID of the assistant that authored this message.
runId String The ID of the run associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints.
attachments List<CreateMessageRequestAttachmentsInner> A list of files attached to the message, and the tools they were added to.
metadata Object Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

Enum: ObjectEnum

Name Value
THREAD_MESSAGE "thread.message"

Enum: StatusEnum

Name Value
IN_PROGRESS "in_progress"
INCOMPLETE "incomplete"
COMPLETED "completed"

Enum: RoleEnum

Name Value
USER "user"
ASSISTANT "assistant"