Skip to content
Last updated

Represents a message input to the model with role-based instruction hierarchy.

Properties

role string required

The role of the message input. One of user, system, or assistant.

texts array optional

Array of text content items.

Show structure

Each text item:

text string required

The text content.

Example: [{ "text": "Hello, how are you?" }]

images array optional

Array of image inputs.

Show structure

Each image item can have:

fileId string optional

Reference to an uploaded file.

url string optional

Direct image URL.

Example: [{ "fileId": "file_abc123" }] or [{ "url": "https://example.com/image.jpg" }]

audio array optional

Array of audio inputs.

Show structure

Each audio item:

fileId string required

Reference to uploaded audio file.

Example: [{ "fileId": "file_audio123" }]

files array optional

Array of file attachments for context (PDFs, documents, etc.).

Show structure

Each file item:

fileId string required

Reference to uploaded file.

Example: [{ "fileId": "file_doc123" }]

id string optional

The unique ID of the input message. Populated when items are returned via API.

Usage

This object is used in:

Examples

{
  "role": "user",
  "texts": [
    { "text": "Hello, how are you?" }
  ]
}