Sign in
Chats v2

Mark chat messages as read (incoming / character messages)

patch/v2/chats/{id}/messages/read

Path parameters

idstring required

Request body

messageIdsstring[] required

Array of message IDs to mark as read

Example request

{
  "messageIds": [
    "message-id-1",
    "message-id-2"
  ]
}

Response

Messages updated

idstring required

The ID of the message

chatIdstring required

The ID of the chat

textstring required

The text of the message

status'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

The status of the message

isFromUserboolean required

Whether the message is from the user

isFromSystemboolean required

Whether the message is a system message

isReadboolean required

Whether the message is read

createdAtstring date-time required

The date and time the message was created

messageType'TEXT' | 'IMAGE_REQUEST' | 'VIDEO_REQUEST' | 'ATTACHMENT' | 'ANIMATE_REQUEST' required

The type of the message

moderationStatus'NONE' | 'ALLOWED' | 'BLOCKED' | 'FAILED_OPEN' | 'FLAGGED' required

Moderation verdict. BLOCKED = hidden from the character (still shown to the user with a notice); FAILED_OPEN = classifier failed and the message was let through.

moderationFeedbackSentboolean required

Whether the user submitted feedback on a blocked message.

isDeletedboolean

Soft-deleted flag. Emitted true so the client removes a message (e.g. a torn-down typing placeholder).

idempotencyKeystring required

The idempotency key of the message

suggestionsstring[]

Suggested follow-up responses for the user

giftSuggestionobject

Gift suggestion from the AI companion

actionsstring[]

Structured UI actions for the client to render

Changes

No recorded changes to this endpoint across all 1 revision of this API.