Create Message
Body
The role of the entity that is creating the message. Allowed values include:
user
: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.assistant
: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.
user
, assistant
The text contents of the message.
A list of files attached to the message, and the tools they should be added to.
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 maxium of 512 characters long.
Response
Represents a message within a thread.
The identifier, which can be referenced in API endpoints.
The object type, which is always thread.message
.
thread.message
The Unix timestamp (in seconds) for when the message was created.
The status of the message, which can be either in_progress
, incomplete
, or completed
.
in_progress
, incomplete
, completed
On an incomplete message, details about why the message is incomplete.
The Unix timestamp (in seconds) for when the message was completed.
The Unix timestamp (in seconds) for when the message was marked as incomplete.
The entity that produced the message. One of user
or assistant
.
user
, assistant
The content of the message in array of text and/or images.
If applicable, the ID of the assistant that authored this message.
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.
A list of files attached to the message, and the tools they were added to.
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 maxium of 512 characters long.
Was this page helpful?