moderation-clientside-api.yaml

components:
  schemas:
    AIImageConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        ocr_rules:
          items:
            $ref: '#/components/schemas/OCRRule'
          type: array
          x-stream-index: "004"
        rules:
          items:
            $ref: '#/components/schemas/AWSRekognitionRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      - ocr_rules
      type: object
    AITextConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        profile:
          type: string
          x-stream-index: "003"
        rules:
          items:
            $ref: '#/components/schemas/BodyguardRule'
          type: array
          x-stream-index: "004"
        severity_rules:
          items:
            $ref: '#/components/schemas/BodyguardSeverityRule'
          type: array
          x-stream-index: "005"
      required:
      - enabled
      - profile
      - rules
      - severity_rules
      type: object
    AIVideoConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/AWSRekognitionRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      type: object
    APIError:
      nullable: true
      properties:
        StatusCode:
          description: Response HTTP status code
          format: int32
          title: Status code
          type: integer
          x-stream-index: "004"
        code:
          description: API error code
          format: int32
          title: Code
          type: integer
          x-stream-index: "001"
        details:
          description: Additional error-specific information
          items:
            type: integer
          title: Details
          type: array
          x-stream-index: "007"
        duration:
          description: Request duration
          title: Duration
          type: string
          x-stream-index: "005"
        exception_fields:
          additionalProperties:
            type: string
          description: Additional error info
          title: Exception fields
          type: object
          x-stream-index: "003"
        message:
          description: Message describing an error
          title: Message
          type: string
          x-stream-index: "002"
        more_info:
          description: URL with additional information
          title: More info
          type: string
          x-stream-index: "006"
        unrecoverable:
          description: Flag that indicates if the error is unrecoverable, requests
            that return unrecoverable errors should not be retried, this error only
            applies to the request that caused it
          title: Unrecoverable
          type: boolean
          x-stream-index: "008"
      required:
      - code
      - message
      - StatusCode
      - duration
      - more_info
      - details
      title: Error response
      type: object
    AWSRekognitionRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          type: string
          x-stream-index: "002"
        label:
          type: string
          x-stream-index: "001"
        min_confidence:
          format: float
          maximum: 100
          minimum: 0
          type: number
          x-stream-index: "003"
      required:
      - label
      - action
      - min_confidence
      type: object
    Action:
      nullable: true
      properties:
        name:
          type: string
          x-stream-index: "001"
        style:
          type: string
          x-stream-index: "003"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "004"
        value:
          type: string
          x-stream-index: "005"
      required:
      - name
      - text
      - type
      type: object
    ActionLogResponse:
      nullable: true
      properties:
        ai_providers:
          items:
            type: string
          type: array
          x-stream-index: "011"
        created_at:
          description: Timestamp when the action was taken
          format: date-time
          title: Created At
          type: number
          x-stream-index: "002"
        custom:
          additionalProperties: {}
          description: Additional metadata about the action
          title: Custom
          type: object
          x-stream-index: "007"
        id:
          description: Unique identifier of the action log
          title: ID
          type: string
          x-stream-index: "001"
        reason:
          description: Reason for the moderation action
          title: Reason
          type: string
          x-stream-index: "006"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: Associated review queue item
          title: Review Queue Item
          x-stream-index: "008"
        target_user:
          $ref: '#/components/schemas/UserResponse'
          description: User who was the target of the action
          title: Target User
          x-stream-index: "009"
        target_user_id:
          description: ID of the user who was the target of the action
          title: Target User ID
          type: string
          x-stream-index: "010"
        type:
          description: Type of moderation action
          title: Type
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who performed the action
          title: User
          x-stream-index: "004"
        user_id:
          description: ID of the user who performed the action
          title: User ID
          type: string
          x-stream-index: "005"
      required:
      - id
      - created_at
      - type
      - user_id
      - reason
      - custom
      - target_user_id
      - ai_providers
      type: object
    ActionSequence:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blur:
          type: boolean
          x-stream-index: "005"
        cooldown_period:
          format: int32
          type: integer
          x-stream-index: "004"
        threshold:
          format: int32
          type: integer
          x-stream-index: "002"
        time_window:
          format: int32
          type: integer
          x-stream-index: "003"
        warning:
          type: boolean
          x-stream-index: "006"
        warning_text:
          type: string
          x-stream-index: "007"
      required:
      - action
      - threshold
      - time_window
      - cooldown_period
      - blur
      - warning
      - warning_text
      type: object
    ActivityLocation:
      properties:
        lat:
          description: Latitude coordinate
          format: float
          maximum: 90
          minimum: 1.8446744073709552e+19
          title: Latitude
          type: number
          x-stream-index: "001"
        lng:
          description: Longitude coordinate
          format: float
          maximum: 180
          minimum: 1.8446744073709552e+19
          title: Longitude
          type: number
          x-stream-index: "002"
      required:
      - lat
      - lng
      title: Activity Location
      type: object
    ActivityResponse:
      properties:
        attachments:
          description: Media attachments for the activity
          items:
            $ref: '#/components/schemas/Attachment'
          title: Attachments
          type: array
          x-stream-index: "010"
        bookmark_count:
          description: Number of bookmarks on the activity
          format: int32
          title: Bookmark Count
          type: integer
          x-stream-index: "031"
        collections:
          additionalProperties:
            $ref: '#/components/schemas/EnrichedCollectionResponse'
          description: Enriched collection data referenced by this activity
          title: Collections
          type: object
          x-stream-index: "038"
        comment_count:
          description: Number of comments on the activity
          format: int32
          title: Comment Count
          type: integer
          x-stream-index: "030"
        comments:
          description: Latest 5 comments of this activity (comment replies excluded)
          items:
            $ref: '#/components/schemas/CommentResponse'
          title: Comments
          type: array
          x-stream-index: "017"
        created_at:
          description: When the activity was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "008"
        current_feed:
          $ref: '#/components/schemas/FeedResponse'
          description: Feed context for this activity view. If an activity is added
            only to one feed, it's always set. If an activity is added to multiple
            feeds, it's only set when calling the GetOrCreateFeed endpoint.
          title: Current Feed
          x-stream-index: "041"
        custom:
          additionalProperties: {}
          description: Custom data for the activity
          title: Custom Data
          type: object
          x-stream-index: "012"
        deleted_at:
          description: When the activity was deleted
          format: date-time
          title: Deleted At
          type: number
          x-stream-index: "023"
        edited_at:
          description: When the activity was last edited
          format: date-time
          title: Edited At
          type: number
          x-stream-index: "022"
        expires_at:
          description: When the activity will expire
          format: date-time
          title: Expires At
          type: number
          x-stream-index: "024"
        feeds:
          description: List of feed IDs containing this activity
          items:
            type: string
          title: Feeds
          type: array
          x-stream-index: "004"
        filter_tags:
          description: Tags for filtering
          items:
            type: string
          title: Filter Tags
          type: array
          x-stream-index: "026"
        friend_reaction_count:
          description: Total count of reactions from friends on this activity
          format: int32
          title: Friend Reaction Count
          type: integer
          x-stream-index: "040"
        friend_reactions:
          description: Reactions from users the current user follows or has mutual
            follows with
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          title: Friend Reactions
          type: array
          x-stream-index: "039"
        hidden:
          description: If this activity is hidden by this user (using activity feedback)
          title: Hidden
          type: boolean
          x-stream-index: "042"
        id:
          description: Unique identifier for the activity
          title: ID
          type: string
          x-stream-index: "001"
        interest_tags:
          description: Tags for user interests
          items:
            type: string
          title: Interest Tags
          type: array
          x-stream-index: "027"
        is_watched:
          type: boolean
          x-stream-index: "044"
        latest_reactions:
          description: Recent reactions to the activity
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          title: Latest Reactions
          type: array
          x-stream-index: "034"
        location:
          $ref: '#/components/schemas/ActivityLocation'
          description: Geographic location related to the activity
          title: Location
          x-stream-index: "019"
        mentioned_users:
          description: Users mentioned in the activity
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "011"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          description: Moderation information
          title: Moderation
          x-stream-index: "028"
        moderation_action:
          type: string
          x-stream-index: "029"
        notification_context:
          $ref: '#/components/schemas/NotificationContext'
          description: Notification context data for the activity (if this is a reaction,
            comment, follow, etc.)
          title: Notification Context
          x-stream-index: "013"
        own_bookmarks:
          description: Current user's bookmarks for this activity
          items:
            $ref: '#/components/schemas/BookmarkResponse'
          title: Own Bookmarks
          type: array
          x-stream-index: "037"
        own_reactions:
          description: Current user's reactions to this activity
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          title: Own Reactions
          type: array
          x-stream-index: "036"
        parent:
          $ref: '#/components/schemas/ActivityResponse'
          description: Parent activity (if this is a reply/comment)
          title: Parent
          x-stream-index: "020"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          description: Poll attached to this activity
          title: Poll
          x-stream-index: "021"
        popularity:
          description: Popularity score of the activity
          format: int32
          title: Popularity
          type: integer
          x-stream-index: "014"
        preview:
          description: If this activity is obfuscated for this user. For premium content
            where you want to show a preview
          title: Preview
          type: boolean
          x-stream-index: "043"
        reaction_count:
          description: Number of reactions to the activity
          format: int32
          title: Reaction Count
          type: integer
          x-stream-index: "033"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/FeedsReactionGroupResponse'
          description: Grouped reactions by type
          title: Reaction Groups
          type: object
          x-stream-index: "035"
        restrict_replies:
          description: 'Controls who can add comments/replies to this activity. One
            of: everyone, people_i_follow, nobody'
          title: Restrict Replies
          type: string
          x-stream-index: "007"
        score:
          description: Ranking score for this activity
          format: float
          title: Score
          type: number
          x-stream-index: "015"
        search_data:
          additionalProperties: {}
          description: Data for search indexing
          title: Search Data
          type: object
          x-stream-index: "025"
        selector_source:
          description: Which activity selector provided this activity (e.g., 'following',
            'popular', 'interest'). Only set when using multiple activity selectors
            with ranking.
          title: Selector Source
          type: string
          x-stream-index: "016"
        share_count:
          description: Number of times the activity was shared
          format: int32
          title: Share Count
          type: integer
          x-stream-index: "032"
        text:
          description: Text content of the activity
          title: Text
          type: string
          x-stream-index: "018"
        type:
          description: Type of activity
          title: Type
          type: string
          x-stream-index: "002"
        updated_at:
          description: When the activity was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the activity
          title: User
          x-stream-index: "003"
        visibility:
          description: 'Visibility setting for the activity. One of: public, private,
            tag'
          enum:
          - public
          - private
          - tag
          title: Visibility
          type: string
          x-stream-index: "005"
        visibility_tag:
          description: If visibility is 'tag', this is the tag name
          title: Visibility Tag
          type: string
          x-stream-index: "006"
      required:
      - id
      - type
      - user
      - feeds
      - visibility
      - restrict_replies
      - created_at
      - updated_at
      - attachments
      - mentioned_users
      - custom
      - popularity
      - score
      - comments
      - search_data
      - filter_tags
      - interest_tags
      - comment_count
      - bookmark_count
      - share_count
      - reaction_count
      - latest_reactions
      - reaction_groups
      - own_reactions
      - own_bookmarks
      - collections
      - hidden
      - preview
      title: Base Activity
      type: object
    AppealItemResponse:
      properties:
        appeal_reason:
          description: Reason Text of the Appeal Item
          title: Appeal Reason
          type: string
          x-stream-index: "006"
        attachments:
          description: Attachments(e.g. Images) of the Appeal Item
          items:
            type: string
          title: Attachments
          type: array
          x-stream-index: "009"
        created_at:
          description: When the flag was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "010"
        decision_reason:
          description: Decision Reason of the Appeal Item
          title: Decision Reason
          type: string
          x-stream-index: "008"
        entity_content:
          $ref: '#/components/schemas/ModerationPayload'
          x-stream-index: "005"
        entity_id:
          description: ID of the entity
          title: Entity ID
          type: string
          x-stream-index: "004"
        entity_type:
          description: Type of entity
          title: Entity Type
          type: string
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        status:
          description: Status of the Appeal Item
          title: Status
          type: string
          x-stream-index: "007"
        updated_at:
          description: When the flag was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "011"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Details of the user who created the appeal
          title: User
          x-stream-index: "002"
      required:
      - id
      - entity_type
      - entity_id
      - appeal_reason
      - status
      - created_at
      - updated_at
      type: object
    AppealRequest:
      nullable: true
      properties:
        appeal_reason:
          description: Explanation for why the content is being appealed
          maxLength: 500
          title: Appeal Reason
          type: string
          x-stream-index: "003"
        attachments:
          description: Array of Attachment URLs(e.g., images)
          items:
            type: string
          maxItems: 10
          title: Attachments
          type: array
          x-stream-index: "004"
        entity_id:
          description: Unique identifier of the entity being appealed
          title: Entity ID
          type: string
          x-stream-index: "001"
        entity_type:
          description: Type of entity being appealed (e.g., message, user)
          title: Entity Type
          type: string
          x-stream-index: "002"
      required:
      - entity_id
      - entity_type
      - appeal_reason
      type: object
    AppealResponse:
      nullable: true
      properties:
        appeal_id:
          description: Unique identifier of the created Appeal item
          title: Appeal Item ID
          type: string
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - appeal_id
      - duration
      type: object
    Attachment:
      description: An attachment is a message object that represents a file uploaded
        by a user.
      nullable: true
      properties:
        actions:
          items:
            $ref: '#/components/schemas/Action'
          type: array
          x-stream-index: "015"
        asset_url:
          type: string
          x-stream-index: "017"
        author_icon:
          type: string
          x-stream-index: "007"
        author_link:
          type: string
          x-stream-index: "006"
        author_name:
          type: string
          x-stream-index: "005"
        color:
          type: string
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "018"
        fallback:
          type: string
          x-stream-index: "002"
        fields:
          items:
            $ref: '#/components/schemas/Field'
          type: array
          x-stream-index: "016"
        footer:
          type: string
          x-stream-index: "013"
        footer_icon:
          type: string
          x-stream-index: "014"
        giphy:
          $ref: '#/components/schemas/Images'
          x-stream-index: "019"
        image_url:
          type: string
          x-stream-index: "011"
        og_scrape_url:
          type: string
          x-stream-index: "020"
        original_height:
          format: int32
          type: integer
          x-stream-index: "022"
        original_width:
          format: int32
          type: integer
          x-stream-index: "021"
        pretext:
          type: string
          x-stream-index: "004"
        text:
          type: string
          x-stream-index: "010"
        thumb_url:
          type: string
          x-stream-index: "012"
        title:
          type: string
          x-stream-index: "008"
        title_link:
          type: string
          x-stream-index: "009"
        type:
          description: Attachment type (e.g. image, video, url)
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - custom
      title: Attachment
      type: object
      x-stream-docs-page-id: file_uploads
    AudioSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "001"
        default_device:
          enum:
          - speaker
          - earpiece
          type: string
          x-stream-index: "006"
        hifi_audio_enabled:
          type: boolean
          x-stream-index: "008"
        mic_default_on:
          type: boolean
          x-stream-index: "004"
        noise_cancellation:
          $ref: '#/components/schemas/NoiseCancellationSettings'
          x-stream-index: "007"
        opus_dtx_enabled:
          type: boolean
          x-stream-index: "002"
        redundant_coding_enabled:
          type: boolean
          x-stream-index: "003"
        speaker_default_on:
          type: boolean
          x-stream-index: "005"
      required:
      - access_request_enabled
      - opus_dtx_enabled
      - redundant_coding_enabled
      - mic_default_on
      - speaker_default_on
      - default_device
      - hifi_audio_enabled
      type: object
    AutomodPlatformCircumventionConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/AutomodRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      type: object
    AutomodRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          type: string
          x-stream-index: "003"
        label:
          type: string
          x-stream-index: "001"
        threshold:
          format: float
          maximum: 1
          minimum: 0
          type: number
          x-stream-index: "002"
      required:
      - label
      - threshold
      - action
      type: object
    AutomodSemanticFiltersConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/AutomodSemanticFiltersRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      type: object
    AutomodSemanticFiltersRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          type: string
          x-stream-index: "003"
        name:
          type: string
          x-stream-index: "001"
        threshold:
          format: float
          maximum: 1
          minimum: 0
          type: number
          x-stream-index: "002"
      required:
      - name
      - threshold
      - action
      type: object
    AutomodToxicityConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/AutomodRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      type: object
    BackstageSettingsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - enabled
      type: object
    BanActionRequestPayload:
      description: Configuration for ban moderation action
      properties:
        channel_ban_only:
          description: Ban only from specific channel
          title: Channel Ban Only
          type: boolean
          x-stream-index: "004"
        delete_messages:
          description: 'Message deletion mode: soft, pruning, or hard'
          enum:
          - soft
          - pruning
          - hard
          title: Delete Messages
          type: string
          x-stream-index: "006"
        ip_ban:
          description: Whether to ban by IP address
          title: IP Ban
          type: boolean
          x-stream-index: "005"
        reason:
          description: Reason for the ban
          title: Reason
          type: string
          x-stream-index: "003"
        shadow:
          description: Whether this is a shadow ban
          title: Shadow
          type: boolean
          x-stream-index: "002"
        target_user_id:
          description: 'Optional: ban user directly without review item'
          title: Target User ID
          type: string
          x-stream-index: "001"
        timeout:
          description: Duration of ban in minutes
          format: int32
          title: Timeout
          type: integer
          x-stream-index: "007"
      title: BanActionRequest
      type: object
    BanInfoResponse:
      description: Ban information
      nullable: true
      properties:
        created_at:
          description: When the ban was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "006"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the ban
          title: Created By
          x-stream-index: "005"
        expires:
          description: When the ban expires
          format: date-time
          title: Expires
          type: number
          x-stream-index: "002"
        reason:
          description: Reason for the ban
          title: Reason
          type: string
          x-stream-index: "003"
        shadow:
          description: Whether this is a shadow ban
          title: Shadow
          type: boolean
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: The banned user
          title: User
          x-stream-index: "001"
      required:
      - created_at
      title: BanInfo
      type: object
    BanOptions:
      properties:
        delete_messages:
          enum:
          - soft
          - pruning
          - hard
          type: string
          x-stream-index: "005"
        duration:
          format: int32
          type: integer
          x-stream-index: "001"
        ip_ban:
          type: boolean
          x-stream-index: "004"
        reason:
          type: string
          x-stream-index: "002"
        shadow_ban:
          type: boolean
          x-stream-index: "003"
      type: object
    BanRequest:
      nullable: true
      properties:
        banned_by:
          $ref: '#/components/schemas/UserRequest'
          description: Details about the user performing the ban
          title: Banned By
          x-stream-index: "008"
        banned_by_id:
          description: ID of the user performing the ban
          title: Banned By ID
          type: string
          x-stream-index: "007"
        channel_cid:
          description: Channel where the ban applies
          title: Channel CID
          type: string
          x-stream-index: "004"
        delete_messages:
          enum:
          - soft
          - pruning
          - hard
          type: string
          x-stream-index: "009"
        ip_ban:
          description: Whether to ban the user's IP address
          title: IP Ban
          type: boolean
          x-stream-index: "006"
        reason:
          description: Optional explanation for the ban
          title: Reason
          type: string
          x-stream-index: "003"
        shadow:
          description: Whether this is a shadow ban
          title: Shadow
          type: boolean
          x-stream-index: "005"
        target_user_id:
          description: ID of the user to ban
          title: Target User ID
          type: string
          x-stream-index: "001"
        timeout:
          description: Duration of the ban in minutes
          minimum: 0
          title: Timeout
          type: integer
          x-stream-index: "002"
      required:
      - target_user_id
      type: object
    BanResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    BlockActionRequestPayload:
      description: Configuration for block action
      properties:
        reason:
          description: Reason for blocking
          title: Reason
          type: string
          x-stream-index: "001"
      title: BlockActionRequest
      type: object
    BlockListConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/BlockListRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      type: object
    BlockListOptions:
      properties:
        behavior:
          description: 'Blocklist behavior. One of: flag, block, shadow_block'
          enum:
          - flag
          - block
          - shadow_block
          title: Behavior
          type: string
          x-stream-index: "002"
        blocklist:
          description: Blocklist name
          title: Blocklist
          type: string
          x-stream-index: "001"
      required:
      - blocklist
      - behavior
      type: object
    BlockListRule:
      properties:
        action:
          enum:
          - flag
          - mask_flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          type: string
          x-stream-index: "003"
        name:
          type: string
          x-stream-index: "001"
        team:
          type: string
          x-stream-index: "002"
      required:
      - name
      - team
      - action
      type: object
    BodyguardRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          type: string
          x-stream-index: "002"
        label:
          type: string
          x-stream-index: "001"
        severity_rules:
          items:
            $ref: '#/components/schemas/BodyguardSeverityRule'
          type: array
          x-stream-index: "003"
      required:
      - label
      - action
      - severity_rules
      type: object
    BodyguardSeverityRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          type: string
          x-stream-index: "002"
        severity:
          enum:
          - low
          - medium
          - high
          - critical
          type: string
          x-stream-index: "001"
      required:
      - severity
      - action
      type: object
    BookmarkFolderResponse:
      properties:
        created_at:
          description: When the folder was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "005"
        custom:
          additionalProperties: {}
          description: Custom data for the folder
          title: Custom Data
          type: object
          x-stream-index: "004"
        id:
          description: Unique identifier for the folder
          title: ID
          type: string
          x-stream-index: "001"
        name:
          description: Name of the folder
          title: Name
          type: string
          x-stream-index: "003"
        updated_at:
          description: When the folder was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "006"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the folder
          title: User
          x-stream-index: "002"
      required:
      - id
      - user
      - name
      - created_at
      - updated_at
      title: Bookmark Folder
      type: object
    BookmarkResponse:
      properties:
        activity:
          $ref: '#/components/schemas/ActivityResponse'
          description: The bookmarked activity
          title: Activity
          x-stream-index: "002"
        created_at:
          description: When the bookmark was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "005"
        custom:
          additionalProperties: {}
          description: Custom data for the bookmark
          title: Custom Data
          type: object
          x-stream-index: "004"
        folder:
          $ref: '#/components/schemas/BookmarkFolderResponse'
          description: Folder containing this bookmark
          title: Folder
          x-stream-index: "003"
        updated_at:
          description: When the bookmark was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "006"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the bookmark
          title: User
          x-stream-index: "001"
      required:
      - user
      - activity
      - created_at
      - updated_at
      title: Bookmark
      type: object
    BroadcastSettingsResponse:
      description: BroadcastSettingsResponse is the payload for broadcasting settings
      properties:
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "001"
        hls:
          $ref: '#/components/schemas/HLSSettingsResponse'
          title: HLS
          x-stream-index: "002"
        rtmp:
          $ref: '#/components/schemas/RTMPSettingsResponse'
          title: RTMP
          x-stream-index: "003"
      required:
      - enabled
      - hls
      - rtmp
      title: BroadcastSettingsResponse
      type: object
    CallActionOptions:
      properties:
        duration:
          format: int32
          type: integer
          x-stream-index: "003"
        flag_reason:
          type: string
          x-stream-index: "006"
        kick_reason:
          type: string
          x-stream-index: "005"
        mute_audio:
          type: boolean
          x-stream-index: "001"
        mute_video:
          type: boolean
          x-stream-index: "002"
        reason:
          type: string
          x-stream-index: "004"
        warning_text:
          type: string
          x-stream-index: "007"
      type: object
    CallCustomPropertyParameters:
      properties:
        operator:
          type: string
          x-stream-index: "002"
        property_key:
          type: string
          x-stream-index: "001"
      type: object
    CallIngressResponse:
      description: CallIngressResponse is the payload for ingress settings
      properties:
        rtmp:
          $ref: '#/components/schemas/RTMPIngress'
          title: RTMP
          x-stream-index: "001"
        srt:
          $ref: '#/components/schemas/SRTIngress'
          x-stream-index: "003"
        whip:
          $ref: '#/components/schemas/WHIPIngress'
          title: WHIP
          x-stream-index: "002"
      required:
      - rtmp
      - whip
      - srt
      title: CallIngressResponse
      type: object
    CallParticipantResponse:
      properties:
        joined_at:
          format: date-time
          type: number
          x-stream-index: "004"
        role:
          type: string
          x-stream-index: "003"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
        user_session_id:
          type: string
          x-stream-index: "002"
      required:
      - user
      - user_session_id
      - role
      - joined_at
      type: object
    CallResponse:
      description: Represents a call
      properties:
        backstage:
          type: boolean
          x-stream-index: "017"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "019"
        captioning:
          type: boolean
          x-stream-index: "013"
        channel_cid:
          type: string
          x-stream-index: "025"
        cid:
          description: The unique identifier for a call (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: The user that created the call
          title: Created By
          x-stream-index: "007"
        current_session_id:
          type: string
          x-stream-index: "005"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "008"
        egress:
          $ref: '#/components/schemas/EgressResponse'
          x-stream-index: "022"
        ended_at:
          description: Date/time when the call ended
          format: date-time
          title: Ended At
          type: number
          x-stream-index: "015"
        id:
          description: Call ID
          title: ID
          type: string
          x-stream-index: "003"
        ingress:
          $ref: '#/components/schemas/CallIngressResponse'
          x-stream-index: "020"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "024"
        recording:
          type: boolean
          x-stream-index: "011"
        routing_number:
          description: 10-digit routing number for SIP routing
          title: Routing Number
          type: string
          x-stream-index: "026"
        session:
          $ref: '#/components/schemas/CallSessionResponse'
          x-stream-index: "021"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          x-stream-index: "018"
        starts_at:
          description: Date/time when the call will start
          format: date-time
          title: Starts At
          type: number
          x-stream-index: "016"
        team:
          type: string
          x-stream-index: "006"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailResponse'
          x-stream-index: "023"
        transcribing:
          type: boolean
          x-stream-index: "012"
        translating:
          type: boolean
          x-stream-index: "014"
        type:
          description: The type of call
          title: Type
          type: string
          x-stream-index: "002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "010"
      required:
      - type
      - id
      - cid
      - current_session_id
      - created_by
      - custom
      - created_at
      - updated_at
      - recording
      - transcribing
      - captioning
      - translating
      - backstage
      - settings
      - blocked_user_ids
      - ingress
      - egress
      title: CallResponse
      type: object
    CallRuleActionSequence:
      properties:
        actions:
          items:
            type: string
          type: array
          x-stream-index: "002"
        call_options:
          $ref: '#/components/schemas/CallActionOptions'
          x-stream-index: "003"
        violation_number:
          format: int32
          type: integer
          x-stream-index: "001"
      type: object
    CallSessionResponse:
      properties:
        accepted_by:
          additionalProperties:
            format: date-time
            type: number
          type: object
          x-stream-index: "008"
        anonymous_participant_count:
          format: int32
          type: integer
          x-stream-index: "006"
        ended_at:
          format: date-time
          type: number
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        live_ended_at:
          format: date-time
          type: number
          x-stream-index: "011"
        live_started_at:
          format: date-time
          type: number
          x-stream-index: "010"
        missed_by:
          additionalProperties:
            format: date-time
            type: number
          type: object
          x-stream-index: "009"
        participants:
          items:
            $ref: '#/components/schemas/CallParticipantResponse'
          type: array
          x-stream-index: "004"
        participants_count_by_role:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "005"
        rejected_by:
          additionalProperties:
            format: date-time
            type: number
          type: object
          x-stream-index: "007"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002"
        timer_ends_at:
          format: date-time
          type: number
          x-stream-index: "012"
      required:
      - id
      - participants
      - participants_count_by_role
      - anonymous_participant_count
      - rejected_by
      - accepted_by
      - missed_by
      type: object
    CallSettingsResponse:
      properties:
        audio:
          $ref: '#/components/schemas/AudioSettingsResponse'
          x-stream-index: "001"
        backstage:
          $ref: '#/components/schemas/BackstageSettingsResponse'
          x-stream-index: "002"
        broadcasting:
          $ref: '#/components/schemas/BroadcastSettingsResponse'
          x-stream-index: "003"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordingSettingsResponse'
          x-stream-index: "008"
        geofencing:
          $ref: '#/components/schemas/GeofenceSettingsResponse'
          x-stream-index: "004"
        individual_recording:
          $ref: '#/components/schemas/IndividualRecordingSettingsResponse'
          x-stream-index: "006"
        ingress:
          $ref: '#/components/schemas/IngressSettingsResponse'
          x-stream-index: "016"
        limits:
          $ref: '#/components/schemas/LimitsSettingsResponse'
          x-stream-index: "014"
        raw_recording:
          $ref: '#/components/schemas/RawRecordingSettingsResponse'
          x-stream-index: "007"
        recording:
          $ref: '#/components/schemas/RecordSettingsResponse'
          x-stream-index: "005"
        ring:
          $ref: '#/components/schemas/RingSettingsResponse'
          x-stream-index: "009"
        screensharing:
          $ref: '#/components/schemas/ScreensharingSettingsResponse'
          x-stream-index: "010"
        session:
          $ref: '#/components/schemas/SessionSettingsResponse'
          x-stream-index: "015"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailsSettingsResponse'
          x-stream-index: "013"
        transcription:
          $ref: '#/components/schemas/TranscriptionSettingsResponse'
          x-stream-index: "011"
        video:
          $ref: '#/components/schemas/VideoSettingsResponse'
          x-stream-index: "012"
      required:
      - audio
      - backstage
      - broadcasting
      - geofencing
      - recording
      - individual_recording
      - raw_recording
      - frame_recording
      - ring
      - screensharing
      - transcription
      - video
      - thumbnails
      - limits
      - session
      type: object
    CallTypeRuleParameters:
      properties:
        call_type:
          type: string
          x-stream-index: "001"
      type: object
    CallViolationCountParameters:
      properties:
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
        time_window:
          type: string
          x-stream-index: "002"
      type: object
    ChannelConfigWithInfo:
      properties:
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: 001.002.028
        automod:
          enum:
          - disabled
          - simple
          - AI
          type: string
          x-stream-index: 001.002.023
        automod_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.024
        automod_thresholds:
          $ref: '#/components/schemas/Thresholds'
          x-stream-index: 001.002.029
        blocklist:
          type: string
          x-stream-index: 001.002.025
        blocklist_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.026
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListOptions'
          type: array
          x-stream-index: 001.002.027
        commands:
          items:
            $ref: '#/components/schemas/Command'
          type: array
          x-stream-index: "001.003"
        connect_events:
          type: boolean
          x-stream-index: 001.002.004
        count_messages:
          type: boolean
          x-stream-index: 001.002.020
        created_at:
          format: date-time
          type: number
          x-stream-index: 001.001.003
        custom_events:
          type: boolean
          x-stream-index: 001.002.013
        delivery_events:
          type: boolean
          x-stream-index: 001.002.005
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "002"
        mark_messages_pending:
          type: boolean
          x-stream-index: 001.002.016
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: 001.002.022
        mutes:
          type: boolean
          x-stream-index: 001.002.010
        name:
          type: string
          x-stream-index: 001.002.001
        partition_size:
          format: int32
          type: integer
          x-stream-index: 001.002.030
        partition_ttl:
          example: 24h
          format: duration
          nullable: true
          type: string
          x-stream-index: 001.002.031
        polls:
          type: boolean
          x-stream-index: 001.002.017
        push_level:
          enum:
          - all
          - all_mentions
          - mentions
          - direct_mentions
          - none
          type: string
          x-stream-index: 001.002.033
        push_notifications:
          type: boolean
          x-stream-index: 001.002.014
        quotes:
          type: boolean
          x-stream-index: 001.002.009
        reactions:
          type: boolean
          x-stream-index: 001.002.007
        read_events:
          type: boolean
          x-stream-index: 001.002.003
        reminders:
          type: boolean
          x-stream-index: 001.002.015
        replies:
          type: boolean
          x-stream-index: 001.002.008
        search:
          type: boolean
          x-stream-index: 001.002.006
        shared_locations:
          type: boolean
          x-stream-index: 001.002.019
        skip_last_msg_update_for_system_msgs:
          type: boolean
          x-stream-index: 001.002.032
        typing_events:
          type: boolean
          x-stream-index: 001.002.002
        updated_at:
          format: date-time
          type: number
          x-stream-index: 001.001.004
        uploads:
          type: boolean
          x-stream-index: 001.002.011
        url_enrichment:
          type: boolean
          x-stream-index: 001.002.012
        user_message_reminders:
          type: boolean
          x-stream-index: 001.002.018
      required:
      - created_at
      - updated_at
      - name
      - typing_events
      - read_events
      - connect_events
      - delivery_events
      - search
      - reactions
      - replies
      - quotes
      - mutes
      - uploads
      - url_enrichment
      - custom_events
      - push_notifications
      - reminders
      - mark_messages_pending
      - polls
      - user_message_reminders
      - shared_locations
      - count_messages
      - message_retention
      - max_message_length
      - automod
      - automod_behavior
      - skip_last_msg_update_for_system_msgs
      - commands
      type: object
    ChannelMemberResponse:
      nullable: true
      properties:
        archived_at:
          format: date-time
          type: number
          x-stream-index: "016"
        ban_expires:
          description: Expiration date of the ban
          format: date-time
          title: Ban expires
          type: number
          x-stream-index: "013"
        banned:
          description: Whether member is banned this channel or not
          title: Banned
          type: boolean
          x-stream-index: "012"
        channel_role:
          description: Role of the member in the channel
          title: Channel Role
          type: string
          x-stream-index: "018"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "011"
        deleted_messages:
          items:
            type: string
          type: array
          x-stream-index: "020"
        invite_accepted_at:
          description: Date when invite was accepted
          format: date-time
          title: Invited accepted at
          type: number
          x-stream-index: "006"
        invite_rejected_at:
          description: Date when invite was rejected
          format: date-time
          title: Invited rejected at
          type: number
          x-stream-index: "007"
        invited:
          description: Whether member was invited or not
          title: Invited
          type: boolean
          x-stream-index: "005"
        is_moderator:
          description: Whether member is channel moderator or not
          title: Is moderator
          type: boolean
          x-stream-index: "003"
        notifications_muted:
          type: boolean
          x-stream-index: "019"
        pinned_at:
          format: date-time
          type: number
          x-stream-index: "015"
        role:
          description: 'Permission level of the member in the channel (DEPRECATED:
            use channel_role instead). One of: member, moderator, admin, owner'
          title: Role
          type: string
          x-stream-index: "017"
        shadow_banned:
          description: Whether member is shadow banned in this channel or not
          title: Shadow banned
          type: boolean
          x-stream-index: "014"
        status:
          type: string
          x-stream-index: "008"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "010"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        user_id:
          title: User ID
          type: string
          x-stream-index: "001"
      required:
      - custom
      - created_at
      - updated_at
      - banned
      - shadow_banned
      - channel_role
      - notifications_muted
      title: Channel member
      type: object
    ChannelMute:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          description: Channel that is muted
          title: Channel
          x-stream-index: "002"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "004"
        expires:
          description: Date/time of mute expiration
          format: date-time
          title: Expires
          type: number
          x-stream-index: "003"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Owner of channel mute
          title: User
          x-stream-index: "001"
      required:
      - created_at
      - updated_at
      type: object
    ChannelOwnCapability:
      description: All possibility of string to use
      enum:
      - ban-channel-members
      - cast-poll-vote
      - connect-events
      - create-attachment
      - delete-any-message
      - delete-channel
      - delete-own-message
      - delivery-events
      - flag-message
      - freeze-channel
      - join-channel
      - leave-channel
      - mute-channel
      - pin-message
      - query-poll-votes
      - quote-message
      - read-events
      - search-messages
      - send-custom-events
      - send-links
      - send-message
      - send-poll
      - send-reaction
      - send-reply
      - send-restricted-visibility-message
      - send-typing-events
      - set-channel-cooldown
      - share-location
      - skip-slow-mode
      - slow-mode
      - typing-events
      - update-any-message
      - update-channel
      - update-channel-members
      - update-own-message
      - update-thread
      - upload-file
      title: ChannelOwnCapability
      type: string
    ChannelResponse:
      description: Represents channel in chat
      properties:
        auto_translation_enabled:
          description: Whether auto translation is enabled or not
          title: Auto translation
          type: boolean
          x-stream-index: "017"
        auto_translation_language:
          description: Language to translate to when auto translation is active
          title: Auto translation language
          type: string
          x-stream-index: "018"
        blocked:
          description: Whether this channel is blocked by current user or not
          title: Blocked
          type: boolean
          x-stream-index: "023"
        cid:
          description: Channel CID (<type>:<id>)
          title: CID
          type: string
          x-stream-index: "003"
        config:
          $ref: '#/components/schemas/ChannelConfigWithInfo'
          description: Channel configuration
          title: ChannelConfigWithInfo
          x-stream-index: "013"
        cooldown:
          description: Cooldown period after sending each message
          format: int32
          title: Cooldown
          type: integer
          x-stream-index: "020"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "005"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: Creator of the channel
          title: UserResponse
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "026"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "007"
        disabled:
          type: boolean
          x-stream-index: "010"
        filter_tags:
          description: List of filter tags associated with the channel
          items:
            type: string
          title: Filter tags
          type: array
          x-stream-index: "028"
        frozen:
          description: Whether channel is frozen or not
          title: Frozen
          type: boolean
          x-stream-index: "009"
        hidden:
          description: Whether this channel is hidden by current user or not
          title: Hidden
          type: boolean
          x-stream-index: "022"
        hide_messages_before:
          description: Date since when the message history is accessible
          format: date-time
          title: Hide messages before
          type: number
          x-stream-index: "019"
        id:
          description: Channel unique ID
          title: ID
          type: string
          x-stream-index: "001"
        last_message_at:
          description: Date of the last message sent
          format: date-time
          title: Last message at
          type: number
          x-stream-index: "004"
        member_count:
          description: Number of members in the channel
          format: int32
          title: Member count
          type: integer
          x-stream-index: "012"
        members:
          description: List of channel members (max 100)
          items:
            $ref: '#/components/schemas/ChannelMemberResponse'
          title: Channel members
          type: array
          x-stream-index: "011"
        message_count:
          description: Number of messages in the channel
          format: int64
          title: Message count
          type: integer
          x-stream-index: "027"
        mute_expires_at:
          description: Date of mute expiration
          format: date-time
          title: Mute expires at
          type: number
          x-stream-index: "015"
        muted:
          description: Whether this channel is muted or not
          title: Muted
          type: boolean
          x-stream-index: "014"
        own_capabilities:
          description: List of channel capabilities of authenticated user
          items:
            $ref: '#/components/schemas/ChannelOwnCapability'
          title: ChannelOwnCapability
          type: array
          x-stream-index: "021"
        team:
          description: Team the channel belongs to (multi-tenant only)
          title: Team
          type: string
          x-stream-index: "016"
        truncated_at:
          description: Date of the latest truncation of the channel
          format: date-time
          title: UserResponse
          type: number
          x-stream-index: "024"
        truncated_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "025"
        type:
          description: Type of the channel
          title: Type
          type: string
          x-stream-docs-page-id: channel_features
          x-stream-index: "002"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "006"
      required:
      - id
      - type
      - cid
      - created_at
      - updated_at
      - frozen
      - disabled
      - custom
      title: Channel
      type: object
    ClosedCaptionRuleParameters:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "001"
        llm_harm_labels:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "002"
        threshold:
          format: int32
          type: integer
          x-stream-index: "003"
      type: object
    Command:
      description: Represents custom chat command
      nullable: true
      properties:
        args:
          description: Arguments help text, shown in commands auto-completion
          title: Arguments
          type: string
          x-stream-index: "006"
        created_at:
          description: Date/time of creation
          format: date-time
          readOnly: true
          title: Created at
          type: number
          x-stream-index: "001"
        description:
          description: Description, shown in commands auto-completion
          title: Description
          type: string
          x-stream-index: "005"
        name:
          description: Unique command name
          title: Name
          type: string
          x-stream-index: "004"
        set:
          description: Set name used for grouping commands
          title: Set
          type: string
          x-stream-index: "007"
        updated_at:
          description: Date/time of the last update
          format: date-time
          readOnly: true
          title: Updated at
          type: number
          x-stream-index: "002"
      required:
      - name
      - description
      - args
      - set
      title: Command
      type: object
    CommentResponse:
      properties:
        attachments:
          description: Attachments associated with the comment
          items:
            $ref: '#/components/schemas/Attachment'
          title: Attachments
          type: array
          x-stream-index: "011"
        confidence_score:
          description: Confidence score of the comment
          format: float
          title: Confidence Score
          type: number
          x-stream-index: "023"
        controversy_score:
          description: Controversy score of the comment
          format: float
          title: Controversy Score
          type: number
          x-stream-index: "024"
        created_at:
          description: When the comment was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "014"
        custom:
          additionalProperties: {}
          description: Custom data for the comment
          title: Custom Data
          type: object
          x-stream-index: "006"
        deleted_at:
          description: When the comment was deleted
          format: date-time
          title: Deleted At
          type: number
          x-stream-index: "017"
        downvote_count:
          description: Number of downvotes for this comment
          format: int32
          title: Downvote Count
          type: integer
          x-stream-index: "021"
        edited_at:
          description: When the comment was last edited
          format: date-time
          title: Edited At
          type: number
          x-stream-index: "016"
        id:
          description: Unique identifier for the comment
          title: ID
          type: string
          x-stream-index: "001"
        latest_reactions:
          description: Recent reactions to the comment
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          title: Latest Reactions
          type: array
          x-stream-index: "009"
        mentioned_users:
          description: Users mentioned in the comment
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "012"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          description: Moderation details for the comment
          title: Moderation
          x-stream-index: "018"
        object_id:
          description: ID of the object this comment is associated with
          title: Object ID
          type: string
          x-stream-index: "002"
        object_type:
          description: Type of the object this comment is associated with
          title: Object Type
          type: string
          x-stream-index: "003"
        own_reactions:
          description: Current user's reactions to this activity
          items:
            $ref: '#/components/schemas/FeedsReactionResponse'
          title: Own Reactions
          type: array
          x-stream-index: "025"
        parent_id:
          description: ID of parent comment for nested replies
          title: Parent ID
          type: string
          x-stream-index: "007"
        reaction_count:
          description: Number of reactions to this comment
          format: int32
          title: Reaction Count
          type: integer
          x-stream-index: "008"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/FeedsReactionGroupResponse'
          description: Grouped reactions by type
          title: Reaction Groups
          type: object
          x-stream-index: "010"
        reply_count:
          description: Number of replies to this comment
          format: int32
          title: Reply Count
          type: integer
          x-stream-index: "019"
        score:
          description: Score of the comment based on reactions
          format: int32
          title: Score
          type: integer
          x-stream-index: "022"
        status:
          description: 'Status of the comment. One of: active, deleted, removed, hidden'
          title: Status
          type: string
          x-stream-index: "013"
        text:
          description: Text content of the comment
          title: Text
          type: string
          x-stream-index: "005"
        updated_at:
          description: When the comment was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "015"
        upvote_count:
          description: Number of upvotes for this comment
          format: int32
          title: Upvote Count
          type: integer
          x-stream-index: "020"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the comment
          title: User
          x-stream-index: "004"
      required:
      - id
      - object_id
      - object_type
      - user
      - reaction_count
      - mentioned_users
      - status
      - created_at
      - updated_at
      - reply_count
      - upvote_count
      - downvote_count
      - score
      - confidence_score
      - own_reactions
      title: Comment
      type: object
    CompositeRecordingResponse:
      properties:
        status:
          type: string
          x-stream-index: "001"
      required:
      - status
      type: object
    ConfigResponse:
      properties:
        ai_image_config:
          $ref: '#/components/schemas/AIImageConfig'
          description: Configuration for AI image analysis
          title: AI Image Config
          x-stream-index: "010"
        ai_text_config:
          $ref: '#/components/schemas/AITextConfig'
          description: Configuration for AI text analysis
          title: AI Text Config
          x-stream-index: "008"
        ai_video_config:
          $ref: '#/components/schemas/AIVideoConfig'
          description: Configuration for AI video analysis
          title: AI Video Config
          x-stream-index: "011"
        async:
          description: Whether moderation should be performed asynchronously
          title: Async
          type: boolean
          x-stream-index: "003"
        automod_platform_circumvention_config:
          $ref: '#/components/schemas/AutomodPlatformCircumventionConfig'
          description: Configuration for platform circumvention detection
          title: Automod Platform Circumvention Config
          x-stream-index: "005"
        automod_semantic_filters_config:
          $ref: '#/components/schemas/AutomodSemanticFiltersConfig'
          description: Configuration for semantic filtering
          title: Automod Semantic Filters Config
          x-stream-index: "006"
        automod_toxicity_config:
          $ref: '#/components/schemas/AutomodToxicityConfig'
          description: Configuration for toxicity detection
          title: Automod Toxicity Config
          x-stream-index: "004"
        block_list_config:
          $ref: '#/components/schemas/BlockListConfig'
          description: Configuration for block list filtering
          title: Block List Config
          x-stream-index: "007"
        created_at:
          description: When the configuration was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "013"
        key:
          description: Unique identifier for the moderation configuration
          title: Key
          type: string
          x-stream-index: "001"
        llm_config:
          $ref: '#/components/schemas/LLMConfig'
          description: Configuration for customer-configured LLM moderation
          title: LLM Config
          x-stream-index: "009"
        supported_video_call_harm_types:
          items:
            type: string
          type: array
          x-stream-index: "016"
        team:
          description: Team associated with the configuration
          title: Team
          type: string
          x-stream-index: "002"
        updated_at:
          description: When the configuration was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "014"
        velocity_filter_config:
          $ref: '#/components/schemas/VelocityFilterConfig'
          description: Configuration for velocity-based filtering
          title: Velocity Filter Config
          x-stream-index: "012"
        video_call_rule_config:
          $ref: '#/components/schemas/VideoCallRuleConfig'
          x-stream-index: "015"
      required:
      - key
      - team
      - async
      - created_at
      - updated_at
      - supported_video_call_harm_types
      type: object
    ContentCountRuleParameters:
      properties:
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
        time_window:
          type: string
          x-stream-index: "002"
      type: object
    CustomActionRequestPayload:
      description: Configuration for custom moderation action
      properties:
        id:
          description: Custom action identifier
          title: ID
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          description: Custom action options
          title: Options
          type: object
          x-stream-index: "002"
      title: CustomActionRequest
      type: object
    Data:
      properties:
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    DeleteActivityRequestPayload:
      description: Configuration for activity deletion action
      properties:
        hard_delete:
          description: Whether to permanently delete the activity
          title: Hard Delete
          type: boolean
          x-stream-index: "001"
        reason:
          description: Reason for deletion
          title: Reason
          type: string
          x-stream-index: "002"
      title: DeleteActivityRequest
      type: object
    DeleteCommentRequestPayload:
      description: Configuration for comment deletion action
      properties:
        hard_delete:
          description: Whether to permanently delete the comment
          title: Hard Delete
          type: boolean
          x-stream-index: "001"
        reason:
          description: Reason for deletion
          title: Reason
          type: string
          x-stream-index: "002"
      title: DeleteCommentRequest
      type: object
    DeleteMessageRequestPayload:
      description: Configuration for message deletion action
      properties:
        hard_delete:
          description: Whether to permanently delete the message
          title: Hard Delete
          type: boolean
          x-stream-index: "001"
        reason:
          description: Reason for deletion
          title: Reason
          type: string
          x-stream-index: "002"
      title: DeleteMessageRequest
      type: object
    DeleteModerationConfigResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    DeleteReactionRequestPayload:
      description: Configuration for reaction deletion action
      properties:
        hard_delete:
          description: Whether to permanently delete the reaction
          title: Hard Delete
          type: boolean
          x-stream-index: "001"
        reason:
          description: Reason for deletion
          title: Reason
          type: string
          x-stream-index: "002"
      title: DeleteReactionRequest
      type: object
    DeleteUserRequestPayload:
      description: Configuration for user deletion action
      properties:
        delete_conversation_channels:
          description: Also delete all user conversations
          title: Delete Conversations
          type: boolean
          x-stream-index: "004"
        delete_feeds_content:
          description: Delete flagged feeds content
          title: Delete Feeds Content
          type: boolean
          x-stream-index: "005"
        hard_delete:
          description: Whether to permanently delete the user
          title: Hard Delete
          type: boolean
          x-stream-index: "001"
        mark_messages_deleted:
          description: Also delete all user messages
          title: Mark Messages Deleted
          type: boolean
          x-stream-index: "003"
        reason:
          description: Reason for deletion
          title: Reason
          type: string
          x-stream-index: "002"
      title: DeleteUserRequest
      type: object
    DeliveryReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    DeviceResponse:
      description: Response for Device
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "004"
        disabled:
          description: Whether device is disabled or not
          title: Disabled
          type: boolean
          x-stream-index: "005"
        disabled_reason:
          description: Reason explaining why device had been disabled
          title: Reason
          type: string
          x-stream-index: "006"
        id:
          description: Device ID
          title: ID
          type: string
          x-stream-index: "003"
        push_provider:
          description: Push provider
          title: PushProvider
          type: string
          x-stream-index: "001"
        push_provider_name:
          description: Push provider name
          title: PushProviderName
          type: string
          x-stream-index: "002"
        user_id:
          description: User ID
          title: UserID
          type: string
          x-stream-index: "008"
        voip:
          description: When true the token is for Apple VoIP push notifications
          title: Voip
          type: boolean
          x-stream-index: "007"
      required:
      - push_provider
      - id
      - created_at
      - user_id
      title: DeviceResponse
      type: object
    DraftPayloadResponse:
      description: Contains the draft message content
      properties:
        attachments:
          description: Array of message attachments
          items:
            $ref: '#/components/schemas/Attachment'
          title: Message attachments
          type: array
          x-stream-docs-page-id: message_format#attachment-format
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        html:
          description: Contains HTML markup of the message
          title: HTML content
          type: string
          x-stream-index: "010"
        id:
          description: Message ID is unique string identifier of the message
          title: ID
          type: string
          x-stream-index: "001"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "008"
        mml:
          description: MML content of the message
          title: Messaging Markup Language
          type: string
          x-stream-docs-page-id: mml_overview
          x-stream-index: "003"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "005"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "013"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "009"
        show_in_channel:
          description: Whether thread reply should be shown in the channel as well
          title: Show in channel
          type: boolean
          x-stream-docs-page-id: threads
          x-stream-index: "006"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "012"
        text:
          description: Text of the message
          title: Text
          type: string
          x-stream-index: "002"
        type:
          description: 'Contains type of the message. One of: regular, system'
          title: Message Type
          type: string
          x-stream-docs-page-id: message_format#message-types
          x-stream-index: "011"
      required:
      - id
      - text
      - custom
      title: Draft Message Payload
      type: object
    DraftResponse:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: number
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/DraftPayloadResponse'
          x-stream-index: "001"
        parent_id:
          type: string
          x-stream-index: "004"
        parent_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "005"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "006"
      required:
      - message
      - channel_cid
      - created_at
      type: object
    EgressHLSResponse:
      properties:
        playlist_url:
          type: string
          x-stream-index: "001"
        status:
          type: string
          x-stream-index: "002"
      required:
      - playlist_url
      - status
      type: object
    EgressRTMPResponse:
      properties:
        name:
          type: string
          x-stream-index: "001"
        started_at:
          format: date-time
          type: number
          x-stream-index: "004"
        stream_key:
          type: string
          x-stream-index: "003"
        stream_url:
          type: string
          x-stream-index: "002"
      required:
      - name
      - started_at
      type: object
    EgressResponse:
      properties:
        broadcasting:
          type: boolean
          x-stream-index: "001"
        composite_recording:
          $ref: '#/components/schemas/CompositeRecordingResponse'
          x-stream-index: "005"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordingResponse'
          x-stream-index: "004"
        hls:
          $ref: '#/components/schemas/EgressHLSResponse'
          x-stream-index: "002"
        individual_recording:
          $ref: '#/components/schemas/IndividualRecordingResponse'
          x-stream-index: "006"
        raw_recording:
          $ref: '#/components/schemas/RawRecordingResponse'
          x-stream-index: "007"
        rtmps:
          items:
            $ref: '#/components/schemas/EgressRTMPResponse'
          type: array
          x-stream-index: "003"
      required:
      - broadcasting
      - rtmps
      type: object
    EnrichedActivity:
      properties:
        actor:
          $ref: '#/components/schemas/Data'
          x-stream-index: "002"
        foreign_id:
          type: string
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        latest_reactions:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "013"
        object:
          $ref: '#/components/schemas/Data'
          x-stream-index: "004"
        origin:
          $ref: '#/components/schemas/Data'
          x-stream-index: "008"
        own_reactions:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "012"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "011"
        score:
          format: float
          type: number
          x-stream-index: "010"
        target:
          $ref: '#/components/schemas/Data'
          x-stream-index: "006"
        to:
          items:
            type: string
          type: array
          x-stream-index: "009"
        verb:
          type: string
          x-stream-index: "003"
      type: object
    EnrichedCollectionResponse:
      properties:
        created_at:
          description: When the collection was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "001.005"
        custom:
          additionalProperties: {}
          description: Custom data for the collection
          title: Custom Data
          type: object
          x-stream-index: "001.003"
        id:
          description: Unique identifier for the collection within its name
          title: ID
          type: string
          x-stream-index: "001.002"
        name:
          description: Name/type of the collection
          title: Name
          type: string
          x-stream-index: "001.001"
        status:
          description: 'Enrichment status of the collection. One of: ok, notfound'
          enum:
          - ok
          - notfound
          title: Status
          type: string
          x-stream-index: "002"
        updated_at:
          description: When the collection was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "001.006"
        user_id:
          description: ID of the user who owns this collection
          title: User ID
          type: string
          x-stream-index: "001.004"
      required:
      - name
      - id
      - status
      title: Enriched Collection Response
      type: object
    EnrichedReaction:
      nullable: true
      properties:
        activity_id:
          type: string
          x-stream-index: "003"
        children_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "010"
        created_at:
          $ref: '#/components/schemas/Time'
          x-stream-index: "012"
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        kind:
          type: string
          x-stream-index: "002"
        latest_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "008"
        own_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EnrichedReaction'
            type: array
          type: object
          x-stream-index: "009"
        parent:
          type: string
          x-stream-index: "007"
        target_feeds:
          items:
            type: string
          type: array
          x-stream-index: "006"
        updated_at:
          $ref: '#/components/schemas/Time'
          x-stream-index: "013"
        user:
          $ref: '#/components/schemas/Data'
          x-stream-index: "011"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - kind
      - activity_id
      - user_id
      type: object
    EntityCreatorResponse:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: 001.001.018
        ban_count:
          description: Number of minor actions performed on the user
          format: int32
          title: Ban Count
          type: integer
          x-stream-index: "002"
        banned:
          type: boolean
          x-stream-index: 001.001.012
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: 001.001.017
        created_at:
          format: date-time
          type: number
          x-stream-index: 001.001.009
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: 001.001.004
        deactivated_at:
          format: date-time
          type: number
          x-stream-index: 001.001.016
        deleted_at:
          format: date-time
          type: number
          x-stream-index: 001.001.011
        deleted_content_count:
          description: Number of major actions performed on the user
          format: int32
          title: Deleted Content Count
          type: integer
          x-stream-index: "003"
        flagged_count:
          description: Number of flag actions performed on the user
          format: int32
          title: Flagged Count
          type: integer
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: 001.001.001
        image:
          type: string
          x-stream-index: 001.001.003
        language:
          type: string
          x-stream-index: 001.001.005
        last_active:
          format: date-time
          type: number
          x-stream-index: 001.001.014
        name:
          type: string
          x-stream-index: 001.001.002
        online:
          type: boolean
          x-stream-index: 001.001.013
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: 001.001.015
        role:
          type: string
          x-stream-index: 001.001.006
        teams:
          items:
            type: string
          type: array
          x-stream-index: 001.001.007
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: 001.001.008
        updated_at:
          format: date-time
          type: number
          x-stream-index: 001.001.010
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      - shadow_banned
      - invisible
      - ban_count
      - deleted_content_count
      - flagged_count
      type: object
    FeedMemberResponse:
      properties:
        created_at:
          description: When the membership was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          description: Custom data for the membership
          title: Custom Data
          type: object
          x-stream-index: "007"
        invite_accepted_at:
          description: When the invite was accepted
          format: date-time
          title: Invite Accepted At
          type: number
          x-stream-index: "005"
        invite_rejected_at:
          description: When the invite was rejected
          format: date-time
          title: Invite Rejected At
          type: number
          x-stream-index: "006"
        membership_level:
          $ref: '#/components/schemas/MembershipLevelResponse'
          description: Membership level assigned to the member
          title: Membership Level
          x-stream-index: "004"
        role:
          description: Role of the member in the feed
          title: Role
          type: string
          x-stream-index: "002"
        status:
          description: 'Status of the membership. One of: member, pending, rejected'
          enum:
          - member
          - pending
          - rejected
          title: Status
          type: string
          x-stream-index: "003"
        updated_at:
          description: When the membership was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who is a member
          title: User
          x-stream-index: "001"
      required:
      - user
      - role
      - status
      - created_at
      - updated_at
      title: Feed Member
      type: object
    FeedOwnCapability:
      description: All possibility of string to use
      enum:
      - add-activity
      - add-activity-bookmark
      - add-activity-reaction
      - add-comment
      - add-comment-reaction
      - create-feed
      - delete-any-activity
      - delete-any-comment
      - delete-feed
      - delete-own-activity
      - delete-own-activity-bookmark
      - delete-own-activity-reaction
      - delete-own-comment
      - delete-own-comment-reaction
      - follow
      - pin-activity
      - query-feed-members
      - query-follows
      - read-activities
      - read-feed
      - unfollow
      - update-any-activity
      - update-any-comment
      - update-feed
      - update-feed-followers
      - update-feed-members
      - update-own-activity
      - update-own-activity-bookmark
      - update-own-comment
      title: FeedOwnCapability
      type: string
    FeedResponse:
      properties:
        activity_count:
          format: int32
          type: integer
          x-stream-index: "013"
        created_at:
          description: When the feed was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "019"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the feed
          title: Created By
          x-stream-index: "009"
        custom:
          additionalProperties: {}
          description: Custom data for the feed
          title: Custom Data
          type: object
          x-stream-index: "006"
        deleted_at:
          description: When the feed was deleted
          format: date-time
          title: Deleted At
          type: number
          x-stream-index: "021"
        description:
          description: Description of the feed
          title: Description
          type: string
          x-stream-index: "005"
        feed:
          description: Fully qualified feed ID (group_id:id)
          title: FID
          type: string
          x-stream-index: "003"
        filter_tags:
          description: Tags used for filtering feeds
          items:
            type: string
          title: Filter Tags
          type: array
          x-stream-index: "007"
        follower_count:
          description: Number of followers of this feed
          format: int32
          title: Follower Count
          type: integer
          x-stream-index: "011"
        following_count:
          description: Number of feeds this feed follows
          format: int32
          title: Following Count
          type: integer
          x-stream-index: "012"
        group_id:
          description: Group this feed belongs to
          title: Group ID
          type: string
          x-stream-index: "001"
        id:
          description: Unique identifier for the feed
          title: ID
          type: string
          x-stream-index: "002"
        member_count:
          description: Number of members in this feed
          format: int32
          title: Member Count
          type: integer
          x-stream-index: "010"
        name:
          description: Name of the feed
          title: Name
          type: string
          x-stream-index: "004"
        own_capabilities:
          description: Capabilities the current user has for this feed
          items:
            $ref: '#/components/schemas/FeedOwnCapability'
          title: Own Capabilities
          type: array
          x-stream-index: "017"
        own_followings:
          description: Follow relationships where the feed owner’s feeds are following
            the current user's feeds
          items:
            $ref: '#/components/schemas/FollowResponse'
          title: Own Followings
          type: array
          x-stream-index: "016"
        own_follows:
          description: Follow relationships where the current user's feeds are following
            this feed
          items:
            $ref: '#/components/schemas/FollowResponse'
          title: Own Follows
          type: array
          x-stream-index: "015"
        own_membership:
          $ref: '#/components/schemas/FeedMemberResponse'
          description: Membership information for the current user in this feed
          title: Own Membership
          x-stream-index: "018"
        pin_count:
          description: Number of pinned activities in this feed
          format: int32
          title: Pin Count
          type: integer
          x-stream-index: "014"
        updated_at:
          description: When the feed was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "020"
        visibility:
          description: Visibility setting for the feed
          title: Visibility
          type: string
          x-stream-index: "008"
      required:
      - group_id
      - id
      - feed
      - name
      - description
      - created_by
      - member_count
      - follower_count
      - following_count
      - activity_count
      - pin_count
      - created_at
      - updated_at
      title: Feed
      type: object
    FeedsPreferencesResponse:
      properties:
        comment:
          type: string
          x-stream-index: "002"
        comment_reaction:
          type: string
          x-stream-index: "004"
        custom_activity_types:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "006"
        follow:
          type: string
          x-stream-index: "001"
        mention:
          type: string
          x-stream-index: "005"
        reaction:
          type: string
          x-stream-index: "003"
      type: object
    FeedsReactionGroupResponse:
      properties:
        count:
          description: Number of reactions in this group
          format: int32
          title: Count
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          description: Time of the first reaction
          format: date-time
          title: First Reaction At
          type: number
          x-stream-index: "002"
        last_reaction_at:
          description: Time of the most recent reaction
          format: date-time
          title: Last Reaction At
          type: number
          x-stream-index: "003"
      required:
      - count
      - first_reaction_at
      - last_reaction_at
      title: FeedsReactionGroupResponse
      type: object
    FeedsReactionResponse:
      properties:
        activity_id:
          description: ID of the activity that was reacted to
          title: Activity ID
          type: string
          x-stream-index: "002"
        comment_id:
          description: ID of the comment that was reacted to
          title: Comment ID
          type: string
          x-stream-index: "003"
        created_at:
          description: When the reaction was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          description: Custom data for the reaction
          title: Custom Data
          type: object
          x-stream-index: "005"
        type:
          description: Type of reaction
          title: Type
          type: string
          x-stream-index: "004"
        updated_at:
          description: When the reaction was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User who created the reaction
          title: User
          x-stream-index: "001"
      required:
      - user
      - activity_id
      - type
      - created_at
      - updated_at
      title: Activity Reaction
      type: object
    Field:
      nullable: true
      properties:
        short:
          type: boolean
          x-stream-index: "003"
        title:
          type: string
          x-stream-index: "001"
        value:
          type: string
          x-stream-index: "002"
      required:
      - title
      - value
      - short
      type: object
    FilterConfigResponse:
      properties:
        ai_text_labels:
          items:
            type: string
          type: array
          x-stream-index: "002"
        llm_labels:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - llm_labels
      type: object
    FlagCountRuleParameters:
      properties:
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
      type: object
    FlagRequest:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          description: Additional metadata about the flag
          title: Custom
          type: object
          x-stream-index: "006"
        entity_creator_id:
          description: ID of the user who created the flagged entity
          title: Entity Creator ID
          type: string
          x-stream-index: "003"
        entity_id:
          description: Unique identifier of the entity being flagged
          title: Entity ID
          type: string
          x-stream-index: "002"
        entity_type:
          description: Type of entity being flagged (e.g., message, user)
          title: Entity Type
          type: string
          x-stream-index: "001"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          description: Content being flagged
          title: Moderation Payload
          x-stream-index: "005"
        reason:
          description: Optional explanation for why the content is being flagged
          maxLength: 255
          title: Reason
          type: string
          x-stream-index: "004"
      required:
      - entity_type
      - entity_id
      type: object
    FlagResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        item_id:
          description: Unique identifier of the created moderation item
          title: Item ID
          type: string
          x-stream-index: "001"
      required:
      - item_id
      - duration
      type: object
    FlagUserOptions:
      properties:
        reason:
          type: string
          x-stream-index: "001"
      type: object
    FollowResponse:
      properties:
        created_at:
          description: When the follow relationship was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "009"
        custom:
          additionalProperties: {}
          description: Custom data for the follow relationship
          title: Custom Data
          type: object
          x-stream-index: "004"
        follower_role:
          description: Role of the follower (source user) in the follow relationship
          title: Follower Role
          type: string
          x-stream-index: "008"
        push_preference:
          description: 'Push preference for notifications. One of: all, none'
          enum:
          - all
          - none
          title: Push Preference
          type: string
          x-stream-index: "003"
        request_accepted_at:
          description: When the follow request was accepted
          format: date-time
          title: Request Accepted At
          type: number
          x-stream-index: "005"
        request_rejected_at:
          description: When the follow request was rejected
          format: date-time
          title: Request Rejected At
          type: number
          x-stream-index: "006"
        source_feed:
          $ref: '#/components/schemas/FeedResponse'
          description: Source feed object
          title: Source Feed
          x-stream-index: "001"
        status:
          description: 'Status of the follow relationship. One of: accepted, pending,
            rejected'
          enum:
          - accepted
          - pending
          - rejected
          title: Status
          type: string
          x-stream-index: "007"
        target_feed:
          $ref: '#/components/schemas/FeedResponse'
          description: Target feed object
          title: Target Feed
          x-stream-index: "002"
        updated_at:
          description: When the follow relationship was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "010"
      required:
      - source_feed
      - target_feed
      - push_preference
      - status
      - follower_role
      - created_at
      - updated_at
      title: Follow
      type: object
    FrameRecordingResponse:
      properties:
        status:
          type: string
          x-stream-index: "001"
      required:
      - status
      type: object
    FrameRecordingSettingsResponse:
      properties:
        capture_interval_in_seconds:
          format: int32
          maximum: 60
          minimum: 2
          type: integer
          x-stream-index: "003"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        quality:
          type: string
          x-stream-index: "002"
      required:
      - mode
      - capture_interval_in_seconds
      type: object
    GeofenceSettingsResponse:
      properties:
        names:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - names
      type: object
    GetAppealResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        item:
          $ref: '#/components/schemas/AppealItemResponse'
          description: Current state of the appeal
          title: Item
          x-stream-index: "001"
      required:
      - duration
      type: object
    GetConfigResponse:
      nullable: true
      properties:
        config:
          $ref: '#/components/schemas/ConfigResponse'
          description: The retrieved moderation configuration
          title: Config
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      type: object
    GoogleVisionConfig:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    HLSSettingsResponse:
      description: HLSSettings is the payload for HLS settings
      properties:
        auto_on:
          title: Auto On
          type: boolean
          x-stream-index: "001"
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "002"
        quality_tracks:
          items:
            type: string
          title: Quality Tracks
          type: array
          x-stream-index: "003"
      required:
      - auto_on
      - enabled
      - quality_tracks
      - layout
      title: HLSSettingsResponse
      type: object
    HarmConfig:
      properties:
        action_sequences:
          items:
            $ref: '#/components/schemas/ActionSequence'
          type: array
          x-stream-index: "001"
        cooldown_period:
          format: int32
          type: integer
          x-stream-index: "005"
        harm_types:
          items:
            type: string
          type: array
          x-stream-index: "003"
        severity:
          type: integer
          x-stream-index: "002"
        threshold:
          format: int32
          type: integer
          x-stream-index: "004"
      required:
      - action_sequences
      - severity
      - harm_types
      - threshold
      - cooldown_period
      type: object
    ImageContentParameters:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "001"
      type: object
    ImageData:
      properties:
        frames:
          type: string
          x-stream-index: "005"
        height:
          type: string
          x-stream-index: "003"
        size:
          type: string
          x-stream-index: "004"
        url:
          type: string
          x-stream-index: "001"
        width:
          type: string
          x-stream-index: "002"
      required:
      - url
      - width
      - height
      - size
      - frames
      type: object
    ImageRuleParameters:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "003"
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
        time_window:
          type: string
          x-stream-index: "002"
      type: object
    Images:
      properties:
        fixed_height:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "002"
        fixed_height_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "004"
        fixed_height_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "003"
        fixed_width:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "005"
        fixed_width_downsampled:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "007"
        fixed_width_still:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "006"
        original:
          $ref: '#/components/schemas/ImageData'
          x-stream-index: "001"
      required:
      - original
      - fixed_height
      - fixed_height_still
      - fixed_height_downsampled
      - fixed_width
      - fixed_width_still
      - fixed_width_downsampled
      type: object
    IndividualRecordingResponse:
      properties:
        status:
          type: string
          x-stream-index: "001"
      required:
      - status
      type: object
    IndividualRecordingSettingsResponse:
      properties:
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
      required:
      - mode
      type: object
    IngressAudioEncodingResponse:
      properties:
        bitrate:
          format: int32
          type: integer
          x-stream-index: "003"
        channels:
          format: int32
          type: integer
          x-stream-index: "001"
        enable_dtx:
          type: boolean
          x-stream-index: "002"
      required:
      - channels
      - enable_dtx
      - bitrate
      type: object
    IngressSettingsResponse:
      properties:
        audio_encoding_options:
          $ref: '#/components/schemas/IngressAudioEncodingResponse'
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        video_encoding_options:
          additionalProperties:
            $ref: '#/components/schemas/IngressVideoEncodingResponse'
          type: object
          x-stream-index: "003"
      required:
      - enabled
      type: object
    IngressSourceResponse:
      properties:
        fps:
          type: integer
          x-stream-index: "003"
        height:
          type: integer
          x-stream-index: "002"
        width:
          type: integer
          x-stream-index: "001"
      required:
      - width
      - height
      - fps
      type: object
    IngressVideoEncodingResponse:
      properties:
        layers:
          items:
            $ref: '#/components/schemas/IngressVideoLayerResponse'
          type: array
          x-stream-index: "002"
        source:
          $ref: '#/components/schemas/IngressSourceResponse'
          x-stream-index: "001"
      required:
      - source
      - layers
      type: object
    IngressVideoLayerResponse:
      nullable: true
      properties:
        bitrate:
          type: integer
          x-stream-index: "002"
        codec:
          type: string
          x-stream-index: "001"
        frame_rate_limit:
          type: integer
          x-stream-index: "005"
        max_dimension:
          type: integer
          x-stream-index: "004"
        min_dimension:
          type: integer
          x-stream-index: "003"
      required:
      - codec
      - bitrate
      - min_dimension
      - max_dimension
      - frame_rate_limit
      type: object
    KeyframeRuleParameters:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "001"
        min_confidence:
          format: float
          type: number
          x-stream-index: "003"
        threshold:
          format: int32
          type: integer
          x-stream-index: "002"
      type: object
    LLMConfig:
      properties:
        app_context:
          type: string
          x-stream-index: "005"
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/LLMRule'
          type: array
          x-stream-index: "003"
        severity_descriptions:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "004"
      required:
      - enabled
      - rules
      type: object
    LLMRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          - keep
          type: string
          x-stream-index: "003"
        description:
          type: string
          x-stream-index: "002"
        label:
          type: string
          x-stream-index: "001"
        severity_rules:
          items:
            $ref: '#/components/schemas/BodyguardSeverityRule'
          type: array
          x-stream-index: "004"
      required:
      - label
      - description
      - action
      - severity_rules
      type: object
    LabelThresholds:
      properties:
        block:
          description: Threshold for automatic message block
          format: float
          maximum: 1
          minimum: 0
          title: Block
          type: number
          x-stream-index: "002"
        flag:
          description: Threshold for automatic message flag
          format: float
          maximum: 1
          minimum: 0
          title: Flag
          type: number
          x-stream-index: "001"
      type: object
    LimitsSettingsResponse:
      properties:
        max_duration_seconds:
          format: int32
          type: integer
          x-stream-index: "004"
        max_participants:
          format: int32
          type: integer
          x-stream-index: "001"
        max_participants_exclude_owner:
          type: boolean
          x-stream-index: "003"
        max_participants_exclude_roles:
          items:
            type: string
          type: array
          x-stream-index: "002"
      required:
      - max_participants_exclude_roles
      type: object
    MarkReviewedRequestPayload:
      description: Configuration for mark reviewed action
      properties:
        content_to_mark_as_reviewed_limit:
          description: Maximum content items to mark as reviewed
          format: int32
          maximum: 2500
          title: Content Limit
          type: integer
          x-stream-index: "002"
        decision_reason:
          description: Reason for the appeal decision
          title: Decision Reason
          type: string
          x-stream-index: "003"
        disable_marking_content_as_reviewed:
          description: Skip marking content as reviewed
          title: Disable Marking Content
          type: boolean
          x-stream-index: "001"
      title: MarkReviewedRequest
      type: object
    MembershipLevelResponse:
      properties:
        created_at:
          description: When the membership level was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "007"
        custom:
          additionalProperties: {}
          description: Custom data for the membership level
          title: Custom Data
          type: object
          x-stream-index: "006"
        description:
          description: Description of the membership level
          title: Description
          type: string
          x-stream-index: "003"
        id:
          description: Unique identifier for the membership level
          title: ID
          type: string
          x-stream-index: "001"
        name:
          description: Display name for the membership level
          title: Name
          type: string
          x-stream-index: "002"
        priority:
          description: Priority level
          format: int32
          title: Priority
          type: integer
          x-stream-index: "004"
        tags:
          description: Activity tags this membership level gives access to
          items:
            type: string
          title: Tags
          type: array
          x-stream-index: "005"
        updated_at:
          description: When the membership level was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "008"
      required:
      - id
      - name
      - priority
      - tags
      - created_at
      - updated_at
      title: Membership Level Response
      type: object
    MessageResponse:
      description: Represents any chat message
      properties:
        attachments:
          description: Array of message attachments
          items:
            $ref: '#/components/schemas/Attachment'
          title: Message attachments
          type: array
          x-stream-docs-page-id: message_format#attachment-format
          x-stream-index: "009"
        cid:
          description: Channel unique identifier in <type>:<id> format
          title: Channel CID
          type: string
          x-stream-index: "024"
        command:
          description: Contains provided slash command
          title: Command
          type: string
          x-stream-docs-page-id: custom_commands_webhook
          x-stream-index: "004"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "025"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "028"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "027"
        deleted_for_me:
          type: boolean
          x-stream-index: "048"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "020"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "045"
        html:
          description: Contains HTML markup of the message. Can only be set when using
            server-side API
          title: HTML content
          type: string
          x-stream-index: "005"
        i18n:
          additionalProperties:
            type: string
          description: Object with translations. Key `language` contains the original
            language key. Other keys contain translations
          title: Internationalization info
          type: object
          x-stream-docs-page-id: translation
          x-stream-index: "034"
        id:
          description: Message ID is unique string identifier of the message
          title: ID
          type: string
          x-stream-index: "001"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          description: Contains image moderation information
          title: Image moderation labels
          type: object
          x-stream-index: "030"
        latest_reactions:
          description: List of 10 latest reactions to this message
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Latest reactions
          type: array
          x-stream-index: "010"
        member:
          $ref: '#/components/schemas/ChannelMemberResponse'
          description: Channel member data for the message sender including only the
            `channel_role`
          title: Member object
          x-stream-index: "008"
        mentioned_channel:
          description: Whether the message mentioned the channel tag
          title: Mentioned Channel
          type: boolean
          x-stream-index: "032"
        mentioned_here:
          description: Whether the message mentioned online users with @here tag
          title: Mentioned Here
          type: boolean
          x-stream-index: "033"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "031"
        message_text_updated_at:
          format: date-time
          type: number
          x-stream-index: "040"
        mml:
          description: Should be empty if `text` is provided. Can only be set when
            using server-side API
          title: Messaging Markup Language
          type: string
          x-stream-docs-page-id: mml_overview
          x-stream-index: "003"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "043"
        own_reactions:
          description: List of 10 latest reactions of authenticated user to this message
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Own reactions
          type: array
          x-stream-index: "011"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "017"
        pin_expires:
          description: Date when pinned message expires
          format: date-time
          title: Pin expiration date
          type: number
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "039"
        pinned:
          description: Whether message is pinned or not
          title: Pinned
          type: boolean
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "036"
        pinned_at:
          description: Date when message got pinned
          format: date-time
          title: Pinned at
          type: number
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "037"
        pinned_by:
          $ref: '#/components/schemas/UserResponse'
          description: Contains user who pinned the message
          title: Pinned by
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "038"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "042"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "041"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          description: Contains quoted message
          title: Quoted message
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "022"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "021"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          description: 'An object containing number of reactions of each type. Key:
            reaction type (string), value: number of reactions (int)'
          title: Reaction counts
          type: object
          x-stream-index: "012"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "016"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          description: 'An object containing scores of reactions of each type. Key:
            reaction type (string), value: total score of reactions (int)'
          title: Reaction scores
          type: object
          x-stream-index: "013"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "046"
        reply_count:
          description: Number of replies to this message
          format: int32
          title: Reply count
          type: integer
          x-stream-index: "019"
        restricted_visibility:
          description: A list of user ids that have restricted visibility to the message,
            if the list is not empty, the message is only visible to the users in
            the list
          items:
            type: string
          title: Restricted visibility
          type: array
          x-stream-index: "044"
        shadowed:
          description: Whether the message was shadowed or not
          title: Shadowed
          type: boolean
          x-stream-docs-page-id: moderation#shadow-ban
          x-stream-index: "029"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          description: Contains shared location data
          title: Shared Location
          x-stream-index: "047"
        show_in_channel:
          description: Whether thread reply should be shown in the channel as well
          title: Show in channel
          type: boolean
          x-stream-docs-page-id: threads
          x-stream-index: "018"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "035"
        text:
          description: Text of the message. Should be empty if `mml` is provided
          title: Text
          type: string
          x-stream-index: "002"
        thread_participants:
          description: List of users who participate in thread
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Thread participants
          type: array
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "023"
        type:
          description: 'Contains type of the message. One of: regular, ephemeral,
            error, reply, system, deleted'
          title: Message Type
          type: string
          x-stream-docs-page-id: message_format#message-types
          x-stream-index: "006"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "026"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: Sender of the message. Required when using server-side API
          title: User object
          x-stream-index: "007"
      required:
      - id
      - text
      - html
      - type
      - user
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - mentioned_channel
      - mentioned_here
      - silent
      - pinned
      - restricted_visibility
      title: Message
      type: object
      x-stream-docs-page-id: send_message
    ModerationActionConfigResponse:
      description: Configuration for a moderation action
      nullable: true
      properties:
        action:
          description: The action to take
          title: Action
          type: string
          x-stream-index: "003"
        custom:
          additionalProperties: {}
          description: Custom data for the action
          title: Custom
          type: object
          x-stream-index: "006"
        description:
          description: Description of what this action does
          title: Description
          type: string
          x-stream-index: "005"
        entity_type:
          description: Type of entity this action applies to
          title: Entity Type
          type: string
          x-stream-index: "001"
        icon:
          description: Icon for the dashboard
          title: Icon
          type: string
          x-stream-index: "004"
        order:
          description: Display order (lower numbers shown first)
          format: int32
          title: Order
          type: integer
          x-stream-index: "002"
      required:
      - entity_type
      - order
      - action
      - icon
      - description
      title: ModerationActionConfig
      type: object
    ModerationCustomActionEvent:
      description: This event is sent when a custom moderation action is executed
      nullable: true
      properties:
        action_id:
          description: The ID of the custom action that was executed
          title: ActionID
          type: string
          x-stream-index: "002"
        action_options:
          additionalProperties: {}
          description: Additional options passed to the custom action
          title: ActionOptions
          type: object
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: The message if the moderated content was a message
          title: Message
          x-stream-index: "005"
        received_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item the action was executed on
          title: ReviewQueueItem
          x-stream-index: "004"
        type:
          default: moderation.custom_action
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - action_id
      - review_queue_item
      title: ModerationCustomActionEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-throttle-group: critical
      x-stream-ws-base-event-name: VideoEvent
    ModerationFlagResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "015"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        entity_creator_id:
          type: string
          x-stream-index: "007"
        entity_id:
          type: string
          x-stream-index: "006"
        entity_type:
          type: string
          x-stream-index: "005"
        labels:
          items:
            type: string
          type: array
          x-stream-index: "011"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayloadResponse'
          x-stream-index: "008"
        reason:
          type: string
          x-stream-index: "009"
        result:
          items:
            additionalProperties: {}
            type: object
          type: array
          x-stream-index: "012"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          x-stream-index: "014"
        review_queue_item_id:
          type: string
          x-stream-index: "013"
        type:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "016"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "004"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - type
      - user_id
      - entity_type
      - entity_id
      - result
      - created_at
      - updated_at
      type: object
    ModerationFlaggedEvent:
      description: This event is sent when content is flagged for moderation
      nullable: true
      properties:
        content_type:
          description: The type of content that was flagged
          title: ContentType
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        object_id:
          description: The ID of the flagged content
          title: ObjectID
          type: string
          x-stream-index: "003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
        type:
          default: moderation.flagged
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - content_type
      - object_id
      title: ModerationFlaggedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-throttle-group: critical
      x-stream-ws-base-event-name: VideoEvent
    ModerationMarkReviewedEvent:
      description: This event is sent when a moderation item is marked as reviewed
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item that was marked as reviewed
          title: ReviewQueueItem
          x-stream-index: "001"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: The message if the reviewed content was a message
          title: Message
          x-stream-index: "002"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        type:
          default: moderation.mark_reviewed
          type: string
          x-stream-index: "003.002"
      required:
      - item
      - type
      - created_at
      - custom
      title: ModerationMarkReviewedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-throttle-group: critical
      x-stream-ws-base-event-name: VideoEvent
    ModerationPayload:
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        images:
          items:
            type: string
          maxItems: 30
          type: array
          x-stream-index: "002"
        texts:
          items:
            type: string
          type: array
          x-stream-index: "001"
        videos:
          items:
            type: string
          type: array
          x-stream-index: "003"
      type: object
    ModerationPayloadResponse:
      description: Content payload for moderation
      properties:
        custom:
          additionalProperties: {}
          description: Custom data for moderation
          title: Custom
          type: object
          x-stream-index: "004"
        images:
          description: Image URLs to moderate
          items:
            type: string
          title: Images
          type: array
          x-stream-index: "002"
        texts:
          description: Text content to moderate
          items:
            type: string
          title: Texts
          type: array
          x-stream-index: "001"
        videos:
          description: Video URLs to moderate
          items:
            type: string
          title: Videos
          type: array
          x-stream-index: "003"
      title: ModerationPayload
      type: object
    ModerationV2Response:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blocklist_matched:
          type: string
          x-stream-index: "005"
        blocklists_matched:
          items:
            type: string
          type: array
          x-stream-index: "006"
        image_harms:
          items:
            type: string
          type: array
          x-stream-index: "004"
        original_text:
          type: string
          x-stream-index: "002"
        platform_circumvented:
          type: boolean
          x-stream-index: "008"
        semantic_filter_matched:
          type: string
          x-stream-index: "007"
        text_harms:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - action
      - original_text
      type: object
    MuteRequest:
      nullable: true
      properties:
        target_ids:
          description: User IDs to mute (if multiple users)
          items:
            type: string
          title: Target IDs
          type: array
          x-stream-index: "001"
        timeout:
          description: Duration of mute in minutes
          minimum: 0
          title: Timeout
          type: integer
          x-stream-index: "002"
      required:
      - target_ids
      title: MuteRequest
      type: object
    MuteResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "004.001"
        mutes:
          description: Object with mutes (if multiple users were muted)
          items:
            $ref: '#/components/schemas/UserMuteResponse'
          title: Mutes
          type: array
          x-stream-index: "001"
        non_existing_users:
          description: A list of users that can't be found. Common cause for this
            is deleted users
          items:
            type: string
          title: Non Existing Users
          type: array
          x-stream-index: "003"
        own_user:
          $ref: '#/components/schemas/OwnUserResponse'
          description: Authorized user object with fresh mutes information
          title: Own User
          x-stream-index: "002"
      required:
      - duration
      title: MuteResponse
      type: object
    NoiseCancellationSettings:
      properties:
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
      required:
      - mode
      type: object
    NotificationComment:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "004"
        comment:
          type: string
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - id
      - user_id
      - comment
      type: object
    NotificationContext:
      properties:
        target:
          $ref: '#/components/schemas/NotificationTarget'
          description: Information about the target of the notification
          title: Notification Target
          x-stream-index: "002"
        trigger:
          $ref: '#/components/schemas/NotificationTrigger'
          description: Information about what triggered the notification
          title: Notification Trigger
          x-stream-index: "001"
      title: NotificationContext
      type: object
    NotificationParentActivity:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "004"
        type:
          type: string
          x-stream-index: "003"
        user_id:
          type: string
          x-stream-index: "002"
      required:
      - id
      type: object
    NotificationTarget:
      properties:
        attachments:
          description: Attachments on the target activity (for activity targets)
          items:
            $ref: '#/components/schemas/Attachment'
          title: Attachments
          type: array
          x-stream-index: "005"
        comment:
          $ref: '#/components/schemas/NotificationComment'
          description: Information about the comment related to the notification (for
            reactions to comments and comments on comments)
          title: Comment
          x-stream-index: "007"
        id:
          description: The ID of the target (activity ID or user ID)
          title: Target ID
          type: string
          x-stream-index: "001"
        name:
          description: The name of the target user (for user targets like follows)
          title: User Name
          type: string
          x-stream-index: "006"
        parent_activity:
          $ref: '#/components/schemas/NotificationParentActivity'
          description: The parent of the target activity (e.g. when target is a share/repost
            with no text)
          title: Parent Activity
          x-stream-index: "008"
        text:
          description: The text content of the target activity (for activity targets)
          title: Activity Text
          type: string
          x-stream-index: "004"
        type:
          description: The type of the target activity (for activity targets)
          title: Activity Type
          type: string
          x-stream-index: "003"
        user_id:
          description: The ID of the user who created the target activity (for activity
            targets)
          title: User ID
          type: string
          x-stream-index: "002"
      required:
      - id
      title: NotificationTarget
      type: object
    NotificationTrigger:
      properties:
        comment:
          $ref: '#/components/schemas/NotificationComment'
          description: Information about the comment that triggered the notification
            (for comment and comment_reply types)
          title: Comment
          x-stream-index: "003"
        text:
          description: Human-readable text describing the notification
          title: Notification Text
          type: string
          x-stream-index: "002"
        type:
          description: The type of notification (mention, reaction, comment, follow,
            etc.)
          title: Notification Type
          type: string
          x-stream-index: "001"
      required:
      - type
      - text
      title: NotificationTrigger
      type: object
    OCRRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - bounce
          - bounce_flag
          - bounce_remove
          type: string
          x-stream-index: "002"
        label:
          type: string
          x-stream-index: "001"
      required:
      - label
      - action
      type: object
    OwnUserResponse:
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        banned:
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "015"
        channel_mutes:
          items:
            $ref: '#/components/schemas/ChannelMute'
          type: array
          x-stream-index: "007"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          format: date-time
          type: number
          x-stream-index: "001.016"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "001.011"
        devices:
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "001.001"
        image:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "005"
        language:
          type: string
          x-stream-index: "001.005"
        last_active:
          format: date-time
          type: number
          x-stream-index: "001.014"
        latest_hidden_channels:
          items:
            type: string
          type: array
          x-stream-index: "013"
        mutes:
          items:
            $ref: '#/components/schemas/UserMuteResponse'
          type: array
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "001.002"
        online:
          type: boolean
          x-stream-index: "001.013"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "003"
        push_preferences:
          $ref: '#/components/schemas/PushPreferencesResponse'
          x-stream-index: "002"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "001.015"
        role:
          type: string
          x-stream-index: "001.006"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "009"
        total_unread_count_by_team:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "010"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "011"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "008"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "012"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - devices
      - invisible
      - mutes
      - channel_mutes
      - unread_count
      - total_unread_count
      - unread_channels
      - unread_threads
      type: object
    PollOptionResponseData:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      type: object
    PollResponseData:
      properties:
        allow_answers:
          type: boolean
          x-stream-index: "008"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "007"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "012"
        created_at:
          format: date-time
          type: number
          x-stream-index: "019"
        created_by:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "018"
        created_by_id:
          type: string
          x-stream-index: "017"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "021"
        description:
          type: string
          x-stream-index: "003"
        enforce_unique_vote:
          type: boolean
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        is_closed:
          type: boolean
          x-stream-index: "009"
        latest_answers:
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          type: array
          x-stream-index: "015"
        latest_votes_by_option:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PollVoteResponseData'
            type: array
          type: object
          x-stream-index: "014"
        max_votes_allowed:
          format: int32
          type: integer
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "002"
        options:
          items:
            $ref: '#/components/schemas/PollOptionResponseData'
          type: array
          x-stream-index: "011"
        own_votes:
          items:
            $ref: '#/components/schemas/PollVoteResponseData'
          type: array
          x-stream-index: "016"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "020"
        vote_count:
          format: int32
          type: integer
          x-stream-index: "010"
        vote_counts_by_option:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "013"
        voting_visibility:
          type: string
          x-stream-index: "004"
      required:
      - id
      - name
      - description
      - voting_visibility
      - enforce_unique_vote
      - allow_user_suggested_options
      - allow_answers
      - vote_count
      - options
      - answers_count
      - vote_counts_by_option
      - latest_votes_by_option
      - latest_answers
      - own_votes
      - created_by_id
      - created_at
      - updated_at
      - custom
      type: object
    PollVoteResponseData:
      nullable: true
      properties:
        answer_text:
          type: string
          x-stream-index: "005"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        id:
          type: string
          x-stream-index: "002"
        is_answer:
          type: boolean
          x-stream-index: "004"
        option_id:
          type: string
          x-stream-index: "003"
        poll_id:
          type: string
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "007"
        user_id:
          type: string
          x-stream-index: "006"
      required:
      - poll_id
      - id
      - option_id
      - created_at
      - updated_at
      type: object
    PrivacySettingsResponse:
      properties:
        delivery_receipts:
          $ref: '#/components/schemas/DeliveryReceiptsResponse'
          x-stream-index: "003"
        read_receipts:
          $ref: '#/components/schemas/ReadReceiptsResponse'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicatorsResponse'
          x-stream-index: "001"
      type: object
    PushPreferencesResponse:
      properties:
        call_level:
          type: string
          x-stream-index: "002"
        chat_level:
          type: string
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: number
          x-stream-index: "005"
        feeds_level:
          type: string
          x-stream-index: "003"
        feeds_preferences:
          $ref: '#/components/schemas/FeedsPreferencesResponse'
          x-stream-index: "004"
      type: object
    QueryAppealsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter conditions for appeals
          title: Filter
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "003.002"
        prev:
          type: string
          x-stream-index: "003.003"
        sort:
          description: Sorting parameters for appeals
          items:
            $ref: '#/components/schemas/SortParamRequest'
          title: Sort
          type: array
          x-stream-index: "002"
      type: object
    QueryAppealsResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "003.001"
        items:
          description: List of Appeal Items
          items:
            $ref: '#/components/schemas/AppealItemResponse'
          title: Items
          type: array
          x-stream-index: "001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - items
      - duration
      type: object
    QueryModerationConfigsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter conditions for moderation configs
          title: Filter
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "003.002"
        prev:
          type: string
          x-stream-index: "003.003"
        sort:
          description: Sorting parameters for the results
          items:
            $ref: '#/components/schemas/SortParamRequest'
          title: Sort
          type: array
          x-stream-index: "002"
      type: object
    QueryModerationConfigsResponse:
      nullable: true
      properties:
        configs:
          description: List of moderation configurations
          items:
            $ref: '#/components/schemas/ConfigResponse'
          title: Configs
          type: array
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "003.001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - configs
      - duration
      type: object
    QueryReviewQueueRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter conditions for review queue items
          title: Filter
          type: object
          x-stream-index: "001"
        limit:
          format: int32
          maximum: 100
          minimum: 0
          type: integer
          x-stream-index: "007.001"
        lock_count:
          description: Number of items to lock (1-25)
          format: int32
          maximum: 25
          minimum: 1
          title: Lock Count
          type: integer
          x-stream-index: "005"
        lock_duration:
          description: Duration for which items should be locked
          title: Lock Duration
          type: integer
          x-stream-index: "004"
        lock_items:
          description: Whether to lock items for review (true), unlock items (false),
            or just fetch (nil)
          title: Lock Items
          type: boolean
          x-stream-index: "003"
        next:
          type: string
          x-stream-index: "007.002"
        prev:
          type: string
          x-stream-index: "007.003"
        sort:
          description: Sorting parameters for the results
          items:
            $ref: '#/components/schemas/SortParamRequest'
          title: Sort
          type: array
          x-stream-index: "002"
        stats_only:
          description: Whether to return only statistics
          title: Stats Only
          type: boolean
          x-stream-index: "006"
      type: object
    QueryReviewQueueResponse:
      nullable: true
      properties:
        action_config:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ModerationActionConfigResponse'
            type: array
          description: Configuration for moderation actions
          title: Action Config
          type: object
          x-stream-index: "002"
        duration:
          type: string
          x-stream-index: "006.001"
        filter_config:
          $ref: '#/components/schemas/FilterConfigResponse'
          description: Configuration for filters in moderation review queue
          title: Filter Config
          x-stream-index: "003"
        items:
          description: List of review queue items
          items:
            $ref: '#/components/schemas/ReviewQueueItemResponse'
          title: Items
          type: array
          x-stream-index: "001"
        next:
          type: string
          x-stream-index: "005.001"
        prev:
          type: string
          x-stream-index: "005.002"
        stats:
          additionalProperties: {}
          description: Statistics about the review queue
          title: Stats
          type: object
          x-stream-index: "004"
      required:
      - items
      - action_config
      - stats
      - duration
      type: object
    RTMPIngress:
      description: RTMP input settings
      properties:
        address:
          title: Address
          type: string
          x-stream-index: "001"
      required:
      - address
      title: RTMPIngress
      type: object
    RTMPSettingsResponse:
      description: RTMPSettingsResponse is the payload for RTMP settings
      properties:
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "001"
        quality:
          title: Quality
          type: string
          x-stream-index: "002"
      required:
      - enabled
      - quality
      - layout
      title: RTMPSettingsResponse
      type: object
    RawRecordingResponse:
      properties:
        status:
          type: string
          x-stream-index: "001"
      required:
      - status
      type: object
    RawRecordingSettingsResponse:
      properties:
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
      required:
      - mode
      type: object
    Reaction:
      properties:
        activity_id:
          type: string
          x-stream-index: "001.003"
        children_counts:
          additionalProperties: {}
          type: object
          x-stream-index: "005"
        created_at:
          format: date-time
          type: number
          x-stream-index: "006"
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "001.005"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "008"
        id:
          type: string
          x-stream-index: "001.001"
        kind:
          type: string
          x-stream-index: "001.002"
        latest_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Reaction'
            type: array
          type: object
          x-stream-index: "003"
        moderation:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        own_children:
          additionalProperties:
            items:
              $ref: '#/components/schemas/Reaction'
            type: array
          type: object
          x-stream-index: "004"
        parent:
          type: string
          x-stream-index: "001.008"
        score:
          format: float
          type: number
          x-stream-index: "009"
        target_feeds:
          items:
            type: string
          type: array
          x-stream-index: "001.006"
        target_feeds_extra_data:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "002"
        user_id:
          type: string
          x-stream-index: "001.004"
      required:
      - kind
      - activity_id
      - user_id
      - created_at
      - updated_at
      type: object
    ReactionGroupResponse:
      description: ReactionGroupResponse contains all information about a reaction
        of the same type.
      nullable: true
      properties:
        count:
          description: Count is the number of reactions of this type.
          format: int32
          title: Count
          type: integer
          x-stream-index: "001"
        first_reaction_at:
          description: FirstReactionAt is the time of the first reaction of this type.
            This is the same also if all reaction of this type are deleted, because
            if someone will react again with the same type, will be preserved the
            sorting.
          format: date-time
          title: FirstReactionAt
          type: number
          x-stream-index: "003"
        last_reaction_at:
          description: LastReactionAt is the time of the last reaction of this type.
          format: date-time
          title: LastReactionAt
          type: number
          x-stream-index: "004"
        sum_scores:
          description: 'SumScores is the sum of all scores of reactions of this type.
            Medium allows you to clap articles more than once and shows the sum of
            all claps from all users. For example, you can send `clap` x5 using `score:
            5`.'
          format: int32
          title: SumScores
          type: integer
          x-stream-index: "002"
      required:
      - count
      - sum_scores
      - first_reaction_at
      - last_reaction_at
      title: ReactionGroupResponse
      type: object
    ReactionResponse:
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "008"
        message_id:
          description: Message ID
          title: Message ID
          type: string
          x-stream-index: "001"
        score:
          description: Score of the reaction
          format: int32
          title: Score
          type: integer
          x-stream-index: "005"
        type:
          description: Type of reaction
          title: Type
          type: string
          x-stream-index: "004"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "007"
        user:
          $ref: '#/components/schemas/UserResponse'
          description: User
          title: UserResponse
          x-stream-index: "003"
        user_id:
          description: User ID
          title: User ID
          type: string
          x-stream-index: "002"
      required:
      - message_id
      - user_id
      - user
      - type
      - score
      - created_at
      - updated_at
      - custom
      type: object
    ReadReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    RecordSettingsResponse:
      description: RecordSettings is the payload for recording settings
      properties:
        audio_only:
          title: Audio Only
          type: boolean
          x-stream-index: "001"
        mode:
          title: Mode
          type: string
          x-stream-index: "002"
        quality:
          title: Quality
          type: string
          x-stream-index: "003"
      required:
      - audio_only
      - mode
      - quality
      - layout
      title: RecordSettingsResponse
      type: object
    RejectAppealRequestPayload:
      description: Configuration for rejecting an appeal
      properties:
        decision_reason:
          description: Reason for rejecting the appeal
          title: Decision Reason
          type: string
          x-stream-index: "001"
      required:
      - decision_reason
      title: RejectAppealRequest
      type: object
    ReminderResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "003"
        channel_cid:
          type: string
          x-stream-index: "002"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "005"
        message_id:
          type: string
          x-stream-index: "004"
        remind_at:
          format: date-time
          type: number
          x-stream-index: "001"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "007"
        user_id:
          type: string
          x-stream-index: "006"
      required:
      - channel_cid
      - message_id
      - user_id
      - created_at
      - updated_at
      type: object
    RestoreActionRequestPayload:
      description: Configuration for restore action
      properties:
        decision_reason:
          description: Reason for the appeal decision
          title: Decision Reason
          type: string
          x-stream-index: "001"
      title: RestoreActionRequest
      type: object
    ReviewQueueItemResponse:
      nullable: true
      properties:
        actions:
          description: Moderation actions taken
          items:
            $ref: '#/components/schemas/ActionLogResponse'
          title: Actions
          type: array
          x-stream-index: "025"
        activity:
          $ref: '#/components/schemas/EnrichedActivity'
          x-stream-index: "017"
        ai_text_severity:
          description: AI-determined text severity
          title: AI Text Severity
          type: string
          x-stream-index: "014"
        appeal:
          $ref: '#/components/schemas/AppealItemResponse'
          description: Appeal submitted for this item if it exists
          title: Appeal
          x-stream-index: "026"
        assigned_to:
          $ref: '#/components/schemas/UserResponse'
          description: Moderator assigned to review this item
          title: Assigned To
          x-stream-index: "022"
        bans:
          description: Associated ban records
          items:
            $ref: '#/components/schemas/BanInfoResponse'
          title: Bans
          type: array
          x-stream-index: "023"
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "019"
        completed_at:
          description: When the review was completed
          format: date-time
          title: Completed At
          type: number
          x-stream-index: "009"
        config_key:
          type: string
          x-stream-index: "032"
        created_at:
          description: When the item was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "002"
        entity_creator:
          $ref: '#/components/schemas/EntityCreatorResponse'
          description: Details about who created the entity
          title: Entity Creator
          x-stream-index: "020"
        entity_creator_id:
          description: ID of who created the entity
          title: Entity Creator ID
          type: string
          x-stream-index: "021"
        entity_id:
          description: ID of the entity being reviewed
          title: Entity ID
          type: string
          x-stream-index: "005"
        entity_type:
          description: Type of entity being reviewed
          title: Entity Type
          type: string
          x-stream-index: "004"
        feeds_v2_activity:
          $ref: '#/components/schemas/EnrichedActivity'
          description: Associated feed activity
          title: Feeds V2 Activity
          x-stream-index: "027"
        feeds_v2_reaction:
          $ref: '#/components/schemas/Reaction'
          description: Associated feed reaction
          title: Feeds V2 Reaction
          x-stream-index: "028"
        feeds_v3_activity:
          $ref: '#/components/schemas/ActivityResponse'
          x-stream-index: "029"
        feeds_v3_comment:
          $ref: '#/components/schemas/CommentResponse'
          x-stream-index: "030"
        flags:
          description: Associated flag records
          items:
            $ref: '#/components/schemas/ModerationFlagResponse'
          title: Flags
          type: array
          x-stream-index: "024"
        flags_count:
          format: int32
          type: integer
          x-stream-index: "033"
        id:
          description: Unique identifier of the review queue item
          title: ID
          type: string
          x-stream-index: "001"
        languages:
          description: Detected languages in the content
          items:
            type: string
          title: Languages
          type: array
          x-stream-index: "012"
        latest_moderator_action:
          type: string
          x-stream-index: "015"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: Associated message details
          title: Message
          x-stream-index: "016"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayloadResponse'
          description: Content being moderated
          title: Moderation Payload
          x-stream-index: "006"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "018"
        recommended_action:
          description: Suggested moderation action
          title: Recommended Action
          type: string
          x-stream-index: "008"
        reviewed_at:
          description: When the item was reviewed
          format: date-time
          title: Reviewed At
          type: number
          x-stream-index: "010"
        reviewed_by:
          description: ID of the moderator who reviewed the item
          title: Reviewed By
          type: string
          x-stream-index: "011"
        severity:
          description: Severity level of the content
          format: int32
          title: Severity
          type: integer
          x-stream-index: "013"
        status:
          description: Current status of the review
          title: Status
          type: string
          x-stream-index: "007"
        teams:
          description: Teams associated with this item
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "031"
        updated_at:
          description: When the item was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "003"
      required:
      - id
      - created_at
      - updated_at
      - entity_type
      - entity_id
      - status
      - recommended_action
      - reviewed_by
      - languages
      - severity
      - ai_text_severity
      - latest_moderator_action
      - bans
      - flags
      - actions
      - flags_count
      type: object
    RingSettingsResponse:
      properties:
        auto_cancel_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "002"
        incoming_call_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "001"
        missed_call_timeout_ms:
          format: int32
          type: integer
          x-stream-index: "003"
      required:
      - incoming_call_timeout_ms
      - auto_cancel_timeout_ms
      - missed_call_timeout_ms
      type: object
    RuleBuilderAction:
      properties:
        ban_options:
          $ref: '#/components/schemas/BanOptions'
          x-stream-index: "002"
        call_options:
          $ref: '#/components/schemas/CallActionOptions'
          x-stream-index: "004"
        flag_user_options:
          $ref: '#/components/schemas/FlagUserOptions'
          x-stream-index: "003"
        type:
          enum:
          - ban_user
          - flag_user
          - flag_content
          - block_content
          - shadow_content
          - bounce_flag_content
          - bounce_content
          - bounce_remove_content
          - mute_video
          - mute_audio
          - blur
          - call_blur
          - end_call
          - kick_user
          - warning
          - call_warning
          - webhook_only
          type: string
          x-stream-index: "001"
      type: object
    RuleBuilderCondition:
      properties:
        call_custom_property_params:
          $ref: '#/components/schemas/CallCustomPropertyParameters'
          x-stream-index: "020"
        call_type_rule_params:
          $ref: '#/components/schemas/CallTypeRuleParameters'
          x-stream-index: "019"
        call_violation_count_params:
          $ref: '#/components/schemas/CallViolationCountParameters'
          x-stream-index: "021"
        closed_caption_rule_params:
          $ref: '#/components/schemas/ClosedCaptionRuleParameters'
          x-stream-index: "018"
        confidence:
          format: float
          type: number
          x-stream-index: "002"
        content_count_rule_params:
          $ref: '#/components/schemas/ContentCountRuleParameters'
          x-stream-index: "007"
        content_flag_count_rule_params:
          $ref: '#/components/schemas/FlagCountRuleParameters'
          x-stream-index: "009"
        image_content_params:
          $ref: '#/components/schemas/ImageContentParameters'
          x-stream-index: "012"
        image_rule_params:
          $ref: '#/components/schemas/ImageRuleParameters'
          x-stream-index: "004"
        keyframe_rule_params:
          $ref: '#/components/schemas/KeyframeRuleParameters'
          x-stream-index: "017"
        text_content_params:
          $ref: '#/components/schemas/TextContentParameters'
          x-stream-index: "011"
        text_rule_params:
          $ref: '#/components/schemas/TextRuleParameters'
          x-stream-index: "003"
        type:
          type: string
          x-stream-index: "001"
        user_created_within_params:
          $ref: '#/components/schemas/UserCreatedWithinParameters'
          x-stream-index: "014"
        user_custom_property_params:
          $ref: '#/components/schemas/UserCustomPropertyParameters'
          x-stream-index: "015"
        user_flag_count_rule_params:
          $ref: '#/components/schemas/FlagCountRuleParameters'
          x-stream-index: "008"
        user_identical_content_count_params:
          $ref: '#/components/schemas/UserIdenticalContentCountParameters'
          x-stream-index: "010"
        user_role_params:
          $ref: '#/components/schemas/UserRoleParameters'
          x-stream-index: "016"
        user_rule_params:
          $ref: '#/components/schemas/UserRuleParameters'
          x-stream-index: "006"
        video_content_params:
          $ref: '#/components/schemas/VideoContentParameters'
          x-stream-index: "013"
        video_rule_params:
          $ref: '#/components/schemas/VideoRuleParameters'
          x-stream-index: "005"
      type: object
    RuleBuilderConditionGroup:
      properties:
        conditions:
          items:
            $ref: '#/components/schemas/RuleBuilderCondition'
          type: array
          x-stream-index: "002"
        logic:
          type: string
          x-stream-index: "001"
      type: object
    RuleBuilderConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        rules:
          items:
            $ref: '#/components/schemas/RuleBuilderRule'
          type: array
          x-stream-index: "002"
      type: object
    RuleBuilderRule:
      properties:
        action:
          $ref: '#/components/schemas/RuleBuilderAction'
          x-stream-index: "006"
        action_sequences:
          items:
            $ref: '#/components/schemas/CallRuleActionSequence'
          type: array
          x-stream-index: "007"
        conditions:
          items:
            $ref: '#/components/schemas/RuleBuilderCondition'
          type: array
          x-stream-index: "003"
        cooldown_period:
          type: string
          x-stream-index: "008"
        groups:
          items:
            $ref: '#/components/schemas/RuleBuilderConditionGroup'
          type: array
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        logic:
          type: string
          x-stream-index: "004"
        rule_type:
          type: string
          x-stream-index: "002"
      required:
      - rule_type
      type: object
    SRTIngress:
      properties:
        address:
          type: string
          x-stream-index: "001"
      required:
      - address
      type: object
    ScreensharingSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      required:
      - enabled
      - access_request_enabled
      type: object
    SessionSettingsResponse:
      properties:
        inactivity_timeout_seconds:
          format: int32
          maximum: 900
          minimum: 5
          type: integer
          x-stream-index: "001"
      required:
      - inactivity_timeout_seconds
      type: object
    ShadowBlockActionRequestPayload:
      description: Configuration for shadow block action
      properties:
        reason:
          description: Reason for shadow blocking
          title: Reason
          type: string
          x-stream-index: "001"
      title: ShadowBlockActionRequest
      type: object
    SharedLocationResponseData:
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "011"
        channel_cid:
          type: string
          x-stream-index: "001"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        created_by_device_id:
          type: string
          x-stream-index: "006"
        end_at:
          format: date-time
          type: number
          x-stream-index: "007"
        latitude:
          format: float
          type: number
          x-stream-index: "004"
        longitude:
          format: float
          type: number
          x-stream-index: "005"
        message:
          $ref: '#/components/schemas/MessageResponse'
          x-stream-index: "010"
        message_id:
          type: string
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user_id:
          type: string
          x-stream-index: "003"
      required:
      - channel_cid
      - message_id
      - user_id
      - latitude
      - longitude
      - created_by_device_id
      - created_at
      - updated_at
      type: object
    SortParamRequest:
      nullable: true
      properties:
        direction:
          description: 'Direction of sorting, 1 for Ascending, -1 for Descending,
            default is 1. One of: -1, 1'
          format: int32
          title: Direction
          type: integer
          x-stream-index: "003"
        field:
          description: Name of field to sort by
          title: Field
          type: string
          x-stream-index: "001"
        type:
          description: 'Type of field to sort by. Empty string or omitted means string
            type (default). One of: number, boolean'
          title: Type
          type: string
          x-stream-index: "002"
      type: object
    SpeechSegmentConfig:
      properties:
        max_speech_caption_ms:
          format: int32
          type: integer
          x-stream-index: "001"
        silence_duration_ms:
          format: int32
          type: integer
          x-stream-index: "002"
      type: object
    SubmitActionRequest:
      nullable: true
      properties:
        action_type:
          description: 'Type of moderation action to perform. One of: mark_reviewed,
            delete_message, delete_activity, delete_comment, delete_reaction, ban,
            custom, unban, restore, delete_user, unblock, block, shadow_block, unmask,
            kick_user, end_call'
          enum:
          - flag
          - mark_reviewed
          - delete_message
          - delete_activity
          - delete_comment
          - delete_reaction
          - ban
          - custom
          - unban
          - restore
          - delete_user
          - unblock
          - block
          - shadow_block
          - unmask
          - kick_user
          - end_call
          - reject_appeal
          title: Action Type
          type: string
          x-stream-index: "002"
        appeal_id:
          description: UUID of the appeal to act on (required for reject_appeal, optional
            for other actions)
          title: Appeal ID
          type: string
          x-stream-index: "003"
        ban:
          $ref: '#/components/schemas/BanActionRequestPayload'
          description: Configuration for ban action
          title: Ban
          x-stream-index: "010"
        block:
          $ref: '#/components/schemas/BlockActionRequestPayload'
          description: Configuration for block action
          title: Block
          x-stream-index: "015"
        custom:
          $ref: '#/components/schemas/CustomActionRequestPayload'
          description: Configuration for custom action
          title: Custom
          x-stream-index: "011"
        delete_activity:
          $ref: '#/components/schemas/DeleteActivityRequestPayload'
          description: Configuration for activity deletion action
          title: Delete Activity
          x-stream-index: "005"
        delete_comment:
          $ref: '#/components/schemas/DeleteCommentRequestPayload'
          description: Configuration for comment deletion action
          title: Delete Comment
          x-stream-index: "006"
        delete_message:
          $ref: '#/components/schemas/DeleteMessageRequestPayload'
          description: Configuration for message deletion action
          title: Delete Message
          x-stream-index: "004"
        delete_reaction:
          $ref: '#/components/schemas/DeleteReactionRequestPayload'
          description: Configuration for reaction deletion action
          title: Delete Reaction
          x-stream-index: "007"
        delete_user:
          $ref: '#/components/schemas/DeleteUserRequestPayload'
          description: Configuration for user deletion action
          title: Delete User
          x-stream-index: "008"
        flag:
          $ref: '#/components/schemas/FlagRequest'
          description: Configuration for flag action
          title: Flag
          x-stream-index: "020"
        item_id:
          description: UUID of the review queue item to act on
          title: Item ID
          type: string
          x-stream-index: "001"
        mark_reviewed:
          $ref: '#/components/schemas/MarkReviewedRequestPayload'
          description: Configuration for marking item as reviewed
          title: Mark Reviewed
          x-stream-index: "009"
        reject_appeal:
          $ref: '#/components/schemas/RejectAppealRequestPayload'
          description: Configuration for rejecting an appeal
          title: Reject Appeal
          x-stream-index: "019"
        restore:
          $ref: '#/components/schemas/RestoreActionRequestPayload'
          description: Configuration for restore action
          title: Restore
          x-stream-index: "013"
        shadow_block:
          $ref: '#/components/schemas/ShadowBlockActionRequestPayload'
          description: Configuration for shadow block action
          title: Shadow Block
          x-stream-index: "016"
        unban:
          $ref: '#/components/schemas/UnbanActionRequestPayload'
          description: Configuration for unban action
          title: Unban
          x-stream-index: "012"
        unblock:
          $ref: '#/components/schemas/UnblockActionRequestPayload'
          description: Configuration for unblock action
          title: Unblock
          x-stream-index: "014"
      required:
      - action_type
      type: object
    SubmitActionResponse:
      nullable: true
      properties:
        appeal_item:
          $ref: '#/components/schemas/AppealItemResponse'
          description: Updated Appeal item after action was performed
          title: Appeal Item
          x-stream-index: "002"
        duration:
          type: string
          x-stream-index: "003.001"
        item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: Updated review queue item after action was performed
          title: Item
          x-stream-index: "001"
      required:
      - duration
      type: object
    TargetResolution:
      properties:
        bitrate:
          format: int32
          maximum: 6000000
          type: integer
          x-stream-index: "003"
        height:
          format: int32
          maximum: 3840
          minimum: 240
          type: integer
          x-stream-index: "002"
        width:
          format: int32
          maximum: 3840
          minimum: 240
          type: integer
          x-stream-index: "001"
      required:
      - width
      - height
      - bitrate
      type: object
    TextContentParameters:
      properties:
        blocklist_match:
          items:
            type: string
          type: array
          x-stream-index: "005"
        contains_url:
          type: boolean
          x-stream-index: "003"
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "001"
        llm_harm_labels:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "002"
        severity:
          type: string
          x-stream-index: "004"
      type: object
    TextRuleParameters:
      properties:
        blocklist_match:
          items:
            type: string
          type: array
          x-stream-index: "007"
        contains_url:
          type: boolean
          x-stream-index: "005"
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "003"
        llm_harm_labels:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "004"
        semantic_filter_min_threshold:
          format: float
          type: number
          x-stream-index: "009"
        semantic_filter_names:
          items:
            type: string
          type: array
          x-stream-index: "008"
        severity:
          type: string
          x-stream-index: "006"
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
        time_window:
          type: string
          x-stream-index: "002"
      type: object
    Thresholds:
      description: Sets thresholds for AI moderation
      properties:
        explicit:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for explicit messages
          title: LabelThresholds
          x-stream-index: "001"
        spam:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for spam
          title: LabelThresholds
          x-stream-index: "002"
        toxic:
          $ref: '#/components/schemas/LabelThresholds'
          description: Thresholds for toxic messages
          title: LabelThresholds
          x-stream-index: "003"
      title: Auto moderation thresholds
      type: object
    ThumbnailResponse:
      properties:
        image_url:
          type: string
          x-stream-index: "001"
      required:
      - image_url
      type: object
    ThumbnailsSettingsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    Time:
      type: object
    TranscriptionSettingsResponse:
      properties:
        closed_caption_mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "002"
        language:
          enum:
          - auto
          - en
          - fr
          - es
          - de
          - it
          - nl
          - pt
          - pl
          - ca
          - cs
          - da
          - el
          - fi
          - id
          - ja
          - ru
          - sv
          - ta
          - th
          - tr
          - hu
          - ro
          - zh
          - ar
          - tl
          - he
          - hi
          - hr
          - ko
          - ms
          - "no"
          - uk
          - bg
          - et
          - sl
          - sk
          type: string
          x-stream-index: "004"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          type: string
          x-stream-index: "001"
        speech_segment_config:
          $ref: '#/components/schemas/SpeechSegmentConfig'
          x-stream-index: "006"
        translation:
          $ref: '#/components/schemas/TranslationSettings'
          x-stream-index: "005"
      required:
      - mode
      - closed_caption_mode
      - languages
      - language
      type: object
    TranslationSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        languages:
          items:
            enum:
            - en
            - fr
            - es
            - de
            - it
            - nl
            - pt
            - pl
            - ca
            - cs
            - da
            - el
            - fi
            - id
            - ja
            - ru
            - sv
            - ta
            - th
            - tr
            - hu
            - ro
            - zh
            - ar
            - tl
            - he
            - hi
            - hr
            - ko
            - ms
            - "no"
            - uk
            type: string
          type: array
          x-stream-index: "002"
      required:
      - enabled
      - languages
      type: object
    TypingIndicatorsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    UnbanActionRequestPayload:
      description: Configuration for unban moderation action
      properties:
        channel_cid:
          description: Channel CID for channel-specific unban
          title: Channel CID
          type: string
          x-stream-index: "001"
        decision_reason:
          description: Reason for the appeal decision
          title: Decision Reason
          type: string
          x-stream-index: "002"
      title: UnbanActionRequest
      type: object
    UnblockActionRequestPayload:
      description: Configuration for unblock action
      properties:
        decision_reason:
          description: Reason for the appeal decision
          title: Decision Reason
          type: string
          x-stream-index: "001"
      title: UnblockActionRequest
      type: object
    UpsertConfigRequest:
      nullable: true
      properties:
        ai_image_config:
          $ref: '#/components/schemas/AIImageConfig'
          description: Configuration for AI image analysis
          title: AI Image Config
          x-stream-index: "011"
        ai_text_config:
          $ref: '#/components/schemas/AITextConfig'
          description: Configuration for AI text analysis
          title: AI Text Config
          x-stream-index: "008"
        ai_video_config:
          $ref: '#/components/schemas/AIVideoConfig'
          description: Configuration for AI video analysis
          title: AI Video Config
          x-stream-index: "012"
        async:
          description: Whether moderation should be performed asynchronously
          title: Async
          type: boolean
          x-stream-index: "003"
        automod_platform_circumvention_config:
          $ref: '#/components/schemas/AutomodPlatformCircumventionConfig'
          description: Configuration for platform circumvention detection
          title: Automod Platform Circumvention Config
          x-stream-index: "005"
        automod_semantic_filters_config:
          $ref: '#/components/schemas/AutomodSemanticFiltersConfig'
          description: Configuration for semantic filtering
          title: Automod Semantic Filters Config
          x-stream-index: "006"
        automod_toxicity_config:
          $ref: '#/components/schemas/AutomodToxicityConfig'
          description: Configuration for toxicity detection
          title: Automod Toxicity Config
          x-stream-index: "004"
        aws_rekognition_config:
          $ref: '#/components/schemas/AIImageConfig'
          x-stream-index: "016"
        block_list_config:
          $ref: '#/components/schemas/BlockListConfig'
          description: Configuration for block list filtering
          title: Block List Config
          x-stream-index: "007"
        bodyguard_config:
          $ref: '#/components/schemas/AITextConfig'
          x-stream-index: "015"
        google_vision_config:
          $ref: '#/components/schemas/GoogleVisionConfig'
          description: Configuration for Google Vision integration
          title: Google Vision Config
          x-stream-index: "010"
        key:
          description: Unique identifier for the moderation configuration
          title: Key
          type: string
          x-stream-index: "001"
        llm_config:
          $ref: '#/components/schemas/LLMConfig'
          description: Configuration for customer-configured LLM moderation
          title: LLM Config
          x-stream-index: "009"
        rule_builder_config:
          $ref: '#/components/schemas/RuleBuilderConfig'
          description: Configuration for custom rule builder (max 3 rules, max 5 conditions
            per rule)
          title: Rule Builder Config
          x-stream-index: "014"
        team:
          description: Team associated with the configuration
          maxLength: 128
          minLength: 1
          title: Team
          type: string
          x-stream-index: "002"
        velocity_filter_config:
          $ref: '#/components/schemas/VelocityFilterConfig'
          description: Configuration for velocity-based filtering
          title: Velocity Filter Config
          x-stream-index: "013"
        video_call_rule_config:
          $ref: '#/components/schemas/VideoCallRuleConfig'
          x-stream-index: "017"
      required:
      - key
      type: object
    UpsertConfigResponse:
      nullable: true
      properties:
        config:
          $ref: '#/components/schemas/ConfigResponse'
          description: The created or updated moderation configuration
          title: Config
          x-stream-index: "001"
        duration:
          type: string
          x-stream-index: "002.001"
      required:
      - duration
      type: object
    User:
      properties:
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    UserCreatedWithinParameters:
      properties:
        max_age:
          type: string
          x-stream-index: "001"
      type: object
    UserCustomPropertyParameters:
      properties:
        operator:
          type: string
          x-stream-index: "002"
        property_key:
          type: string
          x-stream-index: "001"
      type: object
    UserIdenticalContentCountParameters:
      properties:
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
        time_window:
          type: string
          x-stream-index: "002"
      type: object
    UserMuteResponse:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004"
        expires:
          format: date-time
          type: number
          x-stream-index: "003"
        target:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "001"
      required:
      - created_at
      - updated_at
      type: object
    UserRequest:
      description: User request object
      properties:
        custom:
          additionalProperties: {}
          description: Custom user data
          title: Custom
          type: object
          x-stream-index: "004"
        id:
          description: User ID
          title: ID
          type: string
          x-stream-index: "001"
        image:
          description: User's profile image URL
          title: Image
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "006"
        language:
          type: string
          x-stream-index: "005"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "002"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "007"
      required:
      - id
      title: UserRequest
      type: object
    UserResponse:
      description: User response object
      properties:
        avg_response_time:
          format: int32
          type: integer
          x-stream-index: "001.018"
        banned:
          description: Whether a user is banned or not
          title: Banned
          type: boolean
          x-stream-index: "001.012"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "001.017"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "001.009"
        custom:
          additionalProperties: {}
          description: Custom data for this object
          title: Custom data
          type: object
          x-stream-index: "001.004"
        deactivated_at:
          description: Date of deactivation
          format: date-time
          title: Deactivated at
          type: number
          x-stream-index: "001.016"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "001.011"
        id:
          description: Unique user identifier
          title: ID
          type: string
          x-stream-index: "001.001"
        image:
          title: Image
          type: string
          x-stream-index: "001.003"
        language:
          description: Preferred language of a user
          title: Language
          type: string
          x-stream-index: "001.005"
        last_active:
          description: Date of last activity
          format: date-time
          title: Last active
          type: number
          x-stream-index: "001.014"
        name:
          description: Optional name of user
          title: Name
          type: string
          x-stream-index: "001.002"
        online:
          description: Whether a user online or not
          title: Online
          type: boolean
          x-stream-index: "001.013"
        revoke_tokens_issued_before:
          description: Revocation date for tokens
          format: date-time
          title: Revoke tokens issued before
          type: number
          x-stream-index: "001.015"
        role:
          description: Determines the set of user permissions
          title: Role
          type: string
          x-stream-index: "001.006"
        teams:
          description: List of teams user is a part of
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "001.007"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.008"
        updated_at:
          description: Date/time of the last update
          format: date-time
          title: Updated at
          type: number
          x-stream-index: "001.010"
      required:
      - id
      - custom
      - language
      - role
      - teams
      - created_at
      - updated_at
      - banned
      - online
      - blocked_user_ids
      - shadow_banned
      - invisible
      title: UserResponse
      type: object
    UserRoleParameters:
      properties:
        operator:
          type: string
          x-stream-index: "001"
        role:
          type: string
          x-stream-index: "002"
      type: object
    UserRuleParameters:
      properties:
        max_age:
          type: string
          x-stream-index: "001"
      type: object
    VelocityFilterConfig:
      properties:
        advanced_filters:
          type: boolean
          x-stream-index: "007"
        async:
          type: boolean
          x-stream-index: "001"
        cascading_actions:
          type: boolean
          x-stream-index: "004"
        cids_per_user:
          format: int32
          type: integer
          x-stream-index: "006"
        enabled:
          type: boolean
          x-stream-index: "002"
        first_message_only:
          type: boolean
          x-stream-index: "005"
        rules:
          items:
            $ref: '#/components/schemas/VelocityFilterConfigRule'
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      - cascading_actions
      - first_message_only
      - cids_per_user
      - advanced_filters
      type: object
    VelocityFilterConfigRule:
      properties:
        action:
          enum:
          - flag
          - shadow
          - remove
          - ban
          type: string
          x-stream-index: "001"
        ban_duration:
          format: int32
          type: integer
          x-stream-index: "002"
        cascading_action:
          enum:
          - flag
          - shadow
          - remove
          - ban
          type: string
          x-stream-index: "006"
        cascading_threshold:
          format: int64
          type: integer
          x-stream-index: "005"
        check_message_context:
          type: boolean
          x-stream-index: "009"
        fast_spam_threshold:
          format: int32
          type: integer
          x-stream-index: "007"
        fast_spam_ttl:
          format: int32
          type: integer
          x-stream-index: "010"
        ip_ban:
          type: boolean
          x-stream-index: "004"
        probation_period:
          format: int32
          type: integer
          x-stream-index: "014"
        shadow_ban:
          type: boolean
          x-stream-index: "003"
        slow_spam_ban_duration:
          format: int32
          type: integer
          x-stream-index: "012"
        slow_spam_threshold:
          format: int32
          type: integer
          x-stream-index: "008"
        slow_spam_ttl:
          format: int32
          type: integer
          x-stream-index: "011"
        url_only:
          type: boolean
          x-stream-index: "013"
      required:
      - action
      - ban_duration
      - shadow_ban
      - ip_ban
      - cascading_threshold
      - cascading_action
      - fast_spam_threshold
      - slow_spam_threshold
      - check_message_context
      - fast_spam_ttl
      - slow_spam_ttl
      - url_only
      - probation_period
      type: object
    VideoCallRuleConfig:
      properties:
        flag_all_labels:
          type: boolean
          x-stream-index: "002"
        flagged_labels:
          items:
            type: string
          type: array
          x-stream-index: "003"
        rules:
          items:
            $ref: '#/components/schemas/HarmConfig'
          type: array
          x-stream-index: "001"
      required:
      - rules
      - flag_all_labels
      - flagged_labels
      type: object
    VideoContentParameters:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "001"
      type: object
    VideoEndCallRequestPayload:
      description: Configuration for ending video call
      title: VideoEndCallRequest
      type: object
    VideoKickUserRequestPayload:
      description: Configuration for kicking user from video call
      title: VideoKickUserRequest
      type: object
    VideoRuleParameters:
      properties:
        harm_labels:
          items:
            type: string
          type: array
          x-stream-index: "003"
        threshold:
          format: int32
          type: integer
          x-stream-index: "001"
        time_window:
          type: string
          x-stream-index: "002"
      type: object
    VideoSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "002"
        camera_default_on:
          type: boolean
          x-stream-index: "004"
        camera_facing:
          enum:
          - front
          - back
          - external
          type: string
          x-stream-index: "005"
        enabled:
          type: boolean
          x-stream-index: "001"
        target_resolution:
          $ref: '#/components/schemas/TargetResolution'
          x-stream-index: "003"
      required:
      - enabled
      - access_request_enabled
      - target_resolution
      - camera_default_on
      - camera_facing
      type: object
    WHIPIngress:
      properties:
        address:
          description: URL for a new whip input, every time a new link is created
          title: Address
          type: string
          x-stream-index: "001"
      required:
      - address
      title: WHIPIngress
      type: object
    WSClientEvent:
      description: The discriminator object for all websocket client events, it maps
        events' payload to the final type
      discriminator:
        mapping:
          moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent'
          moderation.flagged: '#/components/schemas/ModerationFlaggedEvent'
          moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/ModerationCustomActionEvent'
      - $ref: '#/components/schemas/ModerationFlaggedEvent'
      - $ref: '#/components/schemas/ModerationMarkReviewedEvent'
    WSEvent:
      description: The discriminator object for all websocket events, it maps events'
        payload to the final type
      discriminator:
        mapping:
          moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent'
          moderation.flagged: '#/components/schemas/ModerationFlaggedEvent'
          moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/ModerationCustomActionEvent'
      - $ref: '#/components/schemas/ModerationFlaggedEvent'
      - $ref: '#/components/schemas/ModerationMarkReviewedEvent'
  securitySchemes:
    JWT:
      description: |
        JWT should be always provided when stream-auth-type=jwt.

        Using JWT auth request could be authenticated as user or as server-side.

        When using user authentication permission checking is going to be applied to requests based on the user that is
        performing a request.

        The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform
        requests.

        **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not
        shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.
        If you wish, you can configure your application to ignore authentication (see `disable_auth_check`)
        The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.
      in: header
      name: Authorization
      type: apiKey
    api_key:
      description: Application API key should be always set in order to authenticate
        the request.
      in: query
      name: api_key
      type: apiKey
    stream-auth-type:
      description: |-
        Stream-Auth-Type should be always set in order to authenticate the request. Possible
        values: `jwt` or `anonymous`.

        `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization
        header.

        `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available
        to anonymous users.
      in: header
      name: Stream-Auth-Type
      type: apiKey
info:
  title: Stream API
  version: v220.4.0
openapi: 3.0.3
paths:
  /api/v2/moderation/appeal:
    post:
      description: |
        Appeal against the moderation decision
      operationId: appeal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppealRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppealResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Appeal against the moderation decision
      tags:
      - product:moderation
  /api/v2/moderation/appeal/{id}:
    get:
      description: |
        Retrieve a specific appeal item by its ID
      operationId: get_appeal
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Unique identifier of the appeal item to retrieve
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAppealResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get appeal item
      tags:
      - product:moderation
  /api/v2/moderation/appeals:
    post:
      description: |
        Query Appeals
      operationId: query_appeals
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryAppealsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryAppealsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query Appeals
      tags:
      - product:moderation
  /api/v2/moderation/ban:
    post:
      description: |
        Ban a user from a channel or the entire app
      operationId: ban
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BanRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BanResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Ban
      tags:
      - product:moderation
  /api/v2/moderation/config:
    post:
      description: |
        Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.
      operationId: upsert_config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertConfigRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertConfigResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Create or update moderation configuration
      tags:
      - product:moderation
  /api/v2/moderation/config/{key}:
    delete:
      description: |
        Delete a specific moderation policy by its name
      operationId: delete_config
      parameters:
      - in: path
        name: key
        required: true
        schema:
          description: Key of the moderation configuration to delete
          title: Key
          type: string
          x-stream-index: "001"
      - in: query
        name: team
        schema:
          description: Team associated with the configuration
          title: Team
          type: string
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteModerationConfigResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Delete a moderation policy
      tags:
      - product:moderation
    get:
      description: |
        Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.
      operationId: get_config
      parameters:
      - in: path
        name: key
        required: true
        schema:
          description: Key of the moderation configuration to retrieve
          title: Key
          type: string
          x-stream-index: "001"
      - in: query
        name: team
        schema:
          description: Team associated with the configuration
          title: Team
          type: string
          x-stream-index: "002"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Get moderation configuration
      tags:
      - product:moderation
  /api/v2/moderation/configs:
    post:
      description: |
        Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.
      operationId: query_moderation_configs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryModerationConfigsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryModerationConfigsResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query moderation configurations
      tags:
      - product:moderation
  /api/v2/moderation/flag:
    post:
      description: |
        Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.
      operationId: flag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlagRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlagResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Flag content for moderation
      tags:
      - product:moderation
  /api/v2/moderation/mute:
    post:
      description: |
        Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.
      operationId: mute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MuteRequest'
        description: MuteRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MuteResponse'
          description: MuteResponse
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Mute
      tags:
      - product:moderation
  /api/v2/moderation/review_queue:
    post:
      description: |
        Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.
      operationId: query_review_queue
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryReviewQueueRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryReviewQueueResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Query review queue items
      tags:
      - product:moderation
  /api/v2/moderation/submit_action:
    post:
      description: |
        Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.
      operationId: submit_action
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitActionRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitActionResponse'
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Bad request
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: Too many requests
      summary: Submit moderation action
      tags:
      - product:moderation
security:
- JWT: []
  api_key: []
  stream-auth-type: []
- api_key: []
  stream-auth-type: []
servers:
- description: Stream API
  url: https://chat.stream-io-api.com