Create Message

Create a message.

POSThttps://api.portkey.ai/v1/threads/{thread_id}/messages

Path parameters

thread_id*string

The ID of the thread to create a message for.

Body

application/json

role*enum

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.

userassistant

content*one of

Text contentArray of content parts

attachmentsnullable array of object

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

metadatanullable object

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.

Response

200

OK

Body

application/json

id*string

The identifier, which can be referenced in API endpoints.

object*enum

The object type, which is always thread.message.

thread.message

created_at*integer

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

thread_id*string

The thread ID that this message belongs to.

status*enum

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

in_progressincompletecompleted

incomplete_details*nullable object

On an incomplete message, details about why the message is incomplete.

completed_at*nullable integer

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

incomplete_at*nullable integer

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

role*enum

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

userassistant

content*array of one of

The content of the message in array of text and/or images.

assistant_id*nullable string

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

run_id*nullable string

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.

attachments*nullable array of object

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

metadata*nullable object

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.

Response

{
  "id": "text",
  "object": "thread.message",
  "thread_id": "text",
  "status": "in_progress",
  "incomplete_details": {
    "reason": "content_filter"
  },
  "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"
        }
      ]
    }
  ]
}