Interface: ChatMessage

Defined in: packages/sdk/src/types/chat-types.ts:244

Properties

audioFileUuid?

optional audioFileUuid: string | null

Defined in: packages/sdk/src/types/chat-types.ts:270

First-class audio assistant message. audioFileUuid points at a workspace File whose bytes the chat renderer should play. Set together with audioMetadata: an audio message has both fields, a text message has neither.

---

audioMetadata?

optional audioMetadata: AudioMessageMetadata | null

Defined in: packages/sdk/src/types/chat-types.ts:271

---

content

content: string | MessageContentPart[]

Defined in: packages/sdk/src/types/chat-types.ts:247

---

created_at?

optional created_at: string

Defined in: packages/sdk/src/types/chat-types.ts:256

---

email_id?

optional email_id: number

Defined in: packages/sdk/src/types/chat-types.ts:260

---

error?

optional error: object

Defined in: packages/sdk/src/types/chat-types.ts:257

code

code: string

message

message: string

---

error_details?

optional error_details: ChatCompletionError

Defined in: packages/sdk/src/types/chat-types.ts:255

---

failed?

optional failed: boolean

Defined in: packages/sdk/src/types/chat-types.ts:252

---

id

id: string

Defined in: packages/sdk/src/types/chat-types.ts:245

---

inbox_id?

optional inbox_id: number

Defined in: packages/sdk/src/types/chat-types.ts:261

---

memberId?

optional memberId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:262

---

originalContent?

optional originalContent: string | MessageContentPart[]

Defined in: packages/sdk/src/types/chat-types.ts:248

---

reasoning_content?

optional reasoning_content: string

Defined in: packages/sdk/src/types/chat-types.ts:251

---

role

role: MessageRole

Defined in: packages/sdk/src/types/chat-types.ts:246

---

sendAsAssistant?

optional sendAsAssistant: boolean

Defined in: packages/sdk/src/types/chat-types.ts:259

---

smsDeliveryErrorCode?

optional smsDeliveryErrorCode: string | null

Defined in: packages/sdk/src/types/chat-types.ts:274

---

smsDeliveryFailureReason?

optional smsDeliveryFailureReason: string | null

Defined in: packages/sdk/src/types/chat-types.ts:277

Friendly failure reason string. Only set when smsDeliveryStatus is failed or undelivered.

---

smsDeliveryStatus?

optional smsDeliveryStatus: SMSDeliveryStatus | null

Defined in: packages/sdk/src/types/chat-types.ts:273

SMS delivery status (queued/sending/sent/delivered/undelivered/failed). Only set for SMS messages.

---

smsDeliveryUpdatedAt?

optional smsDeliveryUpdatedAt: string | null

Defined in: packages/sdk/src/types/chat-types.ts:275

---

suggestions?

optional suggestions: string[]

Defined in: packages/sdk/src/types/chat-types.ts:258

---

taskId?

optional taskId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:264

---

tokenUsage?

optional tokenUsage: MessageTokenUsageResponse

Defined in: packages/sdk/src/types/chat-types.ts:263

---

tool_call_id?

optional tool_call_id: string

Defined in: packages/sdk/src/types/chat-types.ts:254

---

tool_calls?

optional tool_calls: ToolCall[]

Defined in: packages/sdk/src/types/chat-types.ts:253

---

truncatedAtMs?

optional truncatedAtMs: number

Defined in: packages/sdk/src/types/chat-types.ts:250

---

truncationReason?

optional truncationReason: TruncationReason

Defined in: packages/sdk/src/types/chat-types.ts:249

---

userRating?

optional userRating: number | null

Defined in: packages/sdk/src/types/chat-types.ts:282

Viewer's durable thumbs rating for this assistant message (1.0 up / 0.0 down). Loaded from chat_feedback; null/undefined when the viewer has not rated it.

---

userRatingComment?

optional userRatingComment: string | null

Defined in: packages/sdk/src/types/chat-types.ts:284

Free-text details the viewer attached to their rating, if any.