Skip to main content

04.6.2.20 Retrieve Message

Node Description​

Retrieve Message is an action type node for getting information about a given message by its ID and thread ID.

Node Configuration​

To configure the Retrieve Message node, you must fill in the required fields.

The required* fields include:

  • API Key;
  • Thread ID;
  • Message ID.

API Key​

The field required for entering the API key (see more details here).

Thread ID​

A field for entering the ID of the thread to which the message belongs.

Message ID​

The field for entering the identifier of the message for which information is to be obtained.

Example of launching a node​

It is necessary to run the node Retrieve Message once with the parameters:

  • API Key - Your API key;
  • Thread ID - Your Thread ID;
  • Message ID - Your Message ID.

The result of the Retrieve Message node execution is information about the requested message, including:

  • assistant_id,
  • content,
  • created_at,
  • file_ids,
  • id,
  • metadata,
  • object: thread.message,
  • role: user or assistant,
  • run_id,
  • thread_id.