Interface: ChatMessage

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

Properties

audience?

optional audience: MessageAudience | null

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

ADR-11 provenance: WHO this message is for. agent_only messages are context the member never said and must never render as member speech.

---

audioFileUuid?

optional audioFileUuid: string | null

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

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:330

---

childMessageCount?

optional childMessageCount: number

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

How many messages hang off this one as a detached background trajectory (a forked tool trajectory that outgrew its turn). Non-zero is the cue to offer a "show work" expander; the thread itself is fetched lazily via getChildThreadMessages. Absent/0 for ordinary messages.

---

content

content: string | MessageContentPart[]

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

---

created_at?

optional created_at: string

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

---

email_id?

optional email_id: number

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

---

error?

optional error: object

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

code

code: string

message

message: string

---

error_details?

optional error_details: ChatCompletionError

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

---

failed?

optional failed: boolean

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

---

id

id: string

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

---

inbox_id?

optional inbox_id: number

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

---

memberId?

optional memberId: number | null

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

---

origin?

optional origin: MessageOrigin | null

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

ADR-11 provenance: WHO authored this message. Null on rows written before the column existed — fall back to role.

---

originalContent?

optional originalContent: string | MessageContentPart[]

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

---

parentMessageId?

optional parentMessageId: string | null

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

The fork point this message hangs off, as the PARENT's message uuid (so it joins against id client-side). Null for ordinary main-thread messages.

---

reasoning_content?

optional reasoning_content: string

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

---

role

role: MessageRole

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

---

sendAsAssistant?

optional sendAsAssistant: boolean

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

---

smsDeliveryErrorCode?

optional smsDeliveryErrorCode: string | null

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

---

smsDeliveryFailureReason?

optional smsDeliveryFailureReason: string | null

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

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:332

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:334

---

suggestions?

optional suggestions: string[]

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

---

taskId?

optional taskId: number | null

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

---

tokenUsage?

optional tokenUsage: MessageTokenUsageResponse

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

---

tool_call_id?

optional tool_call_id: string

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

---

tool_calls?

optional tool_calls: ToolCall[]

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

---

truncatedAtMs?

optional truncatedAtMs: number

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

---

truncationReason?

optional truncationReason: TruncationReason

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

---

userRating?

optional userRating: number | null

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

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:343

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