Class Messages

Deprecated

The Assistants API is deprecated in favor of the Responses API

Hierarchy

APIResource
- Messages

Index

Constructors

Methods

create delete list retrieve update

Constructors

constructor

new Messages(client): OpenAIClient.Beta.Threads.Messages
Parameters
- client: OpenAIClient
Returns OpenAIClient.Beta.Threads.Messages
Inherited from APIResource.constructor
- Defined in node_modules/openai/core/resource.d.mts:4

Methods

create

create(threadID, body, options?): APIPromise<OpenAIClient.Beta.Threads.Messages.Message>
Create a message.
Parameters
- threadID: string
- body: MessageCreateParams
- Optionaloptions: RequestOptions
Returns APIPromise<OpenAIClient.Beta.Threads.Messages.Message>
Deprecated
The Assistants API is deprecated in favor of the Responses API
- Defined in node_modules/openai/resources/beta/threads/messages.d.mts:16

delete

delete(messageID, params, options?): APIPromise<MessageDeleted>
Deletes a message.
Parameters
- messageID: string
- params: MessageDeleteParams
- Optionaloptions: RequestOptions
Returns APIPromise<MessageDeleted>
Deprecated
The Assistants API is deprecated in favor of the Responses API
- Defined in node_modules/openai/resources/beta/threads/messages.d.mts:40

list

list(threadID, query?, options?): PagePromise<MessagesPage, OpenAIClient.Beta.Threads.Messages.Message>
Returns a list of messages for a given thread.
Parameters
- threadID: string
- Optionalquery: null | OpenAIClient.Beta.Threads.Messages.MessageListParams
- Optionaloptions: RequestOptions
Returns PagePromise<MessagesPage, OpenAIClient.Beta.Threads.Messages.Message>
Deprecated
The Assistants API is deprecated in favor of the Responses API
- Defined in node_modules/openai/resources/beta/threads/messages.d.mts:34

retrieve

retrieve(messageID, params, options?): APIPromise<OpenAIClient.Beta.Threads.Messages.Message>
Retrieve a message.
Parameters
- messageID: string
- params: MessageRetrieveParams
- Optionaloptions: RequestOptions
Returns APIPromise<OpenAIClient.Beta.Threads.Messages.Message>
Deprecated
The Assistants API is deprecated in favor of the Responses API
- Defined in node_modules/openai/resources/beta/threads/messages.d.mts:22

update

update(messageID, params, options?): APIPromise<OpenAIClient.Beta.Threads.Messages.Message>
Modifies a message.
Parameters
- messageID: string
- params: MessageUpdateParams
- Optionaloptions: RequestOptions
Returns APIPromise<OpenAIClient.Beta.Threads.Messages.Message>
Deprecated
The Assistants API is deprecated in favor of the Responses API
- Defined in node_modules/openai/resources/beta/threads/messages.d.mts:28