Sign in

v44

latestOpenAPI 3.0.0MITraw.githubusercontent.com2024-11-0494279768.0 KB
Assistants

Create a message.

post/threads/{thread_id}/messages

Path parameters

thread_idstring required

The ID of the thread to create a message for.

Request body

role'user' | 'assistant' required

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.
metadataobject nullable

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.

Response

OK

idstring required

The identifier, which can be referenced in API endpoints.

object'thread.message' required

The object type, which is always thread.message.

created_atinteger required

The Unix timestamp (in seconds) for when the message was created.

thread_idstring required

The thread ID that this message belongs to.

status'in_progress' | 'incomplete' | 'completed' required

The status of the message, which can be either in_progress, incomplete, or completed.

completed_atinteger nullable required

The Unix timestamp (in seconds) for when the message was completed.

incomplete_atinteger nullable required

The Unix timestamp (in seconds) for when the message was marked as incomplete.

role'user' | 'assistant' required

The entity that produced the message. One of user or assistant.

assistant_idstring nullable required

If applicable, the ID of the assistant that authored this message.

run_idstring nullable required

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.

metadataobject nullable required

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.