Create Message | Portkey Docs

Create a message.

post

Authorizations

Path parameters

thread_idstringRequired

The ID of the thread to create a message for.

Body

rolestring · enumRequired

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.

Available options:

contentone ofRequired

The text contents of the message.

An array of content parts with a defined type, each can be of type text or images can be passed with image_url or image_file. Image types are only supported on Vision-compatible models.

attachmentsobject[] | nullableOptional

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

metadataobject | nullableOptional

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.

Responses

application/json

objectOptional

Represents a message within a thread.

200

{
  "id": "text",
  "object": "thread.message",
  "created_at": 1,
  "thread_id": "text",
  "status": "in_progress",
  "incomplete_details": {
    "reason": "content_filter"
  },
  "completed_at": 1,
  "incomplete_at": 1,
  "role": "user",
  "content": [
    {
      "type": "image_file",
      "image_file": {
        "file_id": "text",
        "detail": "auto"
      }
    }
  ],
  "assistant_id": "text",
  "run_id": "text",
  "attachments": [
    {
      "file_id": "text",
      "tools": [
        {
          "type": "code_interpreter"
        }
      ]
    }
  ],
  "metadata": {}
}