POST /threads/{thread_id}/messages

Servers

Path parameters

Name Type Required Description
thread_id String Yes

The ID of the thread to create a message for.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
attachments[] Array No

A list of files attached to the message, and the tools they should be added to.

attachments[].tools[] Array No

The tools to add this file to.

attachments[].file_id String No

The ID of the file to attach to the message.

content Yes
metadata Object No

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

role String Yes

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.

Possible values:

  • "assistant"
  • "user"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.