MessageEnvelope

Wrapper around a message with streaming/sequencing metadata

  • kind
    enum
    const:  
    message
    required

    Envelope type

    values
    • message
  • message_snapshot
    required

    A full chat message as delivered by the server inside a MessageEnvelope. Contains both client-provided and server-managed fields.

    • blocks
      Type: array · MessageBlock[]
      required

      Content blocks that make up the message

    • channel_id_from
      Type: string
      deprecated
      required

      Channel identifier of the sender

    • conversation_id
      Type: string Format: uuid
      deprecated
      required

      UUID of the conversation

    • interaction_id
      Type: string Format: uuid
      required

      Groups related messages in a request/response interaction

    • message_id
      Type: string Format: uuid
      required

      Unique message identifier

    • participant_from
      Type: object · MessageParticipant
      required
    • sent_at
      Type: string Format: date-time
      required

      ISO 8601 timestamp

    • status
      Type: string · MessageStatusenum
      required

      Current processing state of the message

      values
      • partial
      • complete
      • error
    • trace_id
      Type: string
      required

      Trace ID for request correlation (server-managed)

    • request_user_feedback
      Type: boolean

      Whether the UI should prompt for user feedback (server-managed)

    • user_feedback_value
      Type: string nullable

      User feedback value if provided

  • operation
    Type: string · EnvelopeOpenum
    required

    Controls how the client should process the message

    values
    • replace
    • complete
    • error
  • proto
    enum
    const:  
    1
    required

    Protocol version. Clients should ignore envelopes with an unrecognized version.

    values
    • 1
  • sequence
    Type: integer
    required

    Monotonically increasing sequence number for ordering envelopes within a message

  • timestamp
    Type: string Format: date-time
    required

    ISO 8601 timestamp of when the envelope was created

  • error
    Type: string

    Error description (present when operation is error)