moderation-serverside-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
    APNS:
      properties:
        body:
          type: string
          x-stream-index: "002"
        content-available:
          format: int32
          type: integer
          x-stream-index: "004"
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        mutable-content:
          format: int32
          type: integer
          x-stream-index: "005"
        sound:
          type: string
          x-stream-index: "003"
        title:
          type: string
          x-stream-index: "001"
      required:
      - title
      - body
      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
    ActionLog:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "002"
        reason:
          type: string
          x-stream-index: "008"
        reporter_type:
          type: string
          x-stream-index: "009"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItem'
          x-stream-index: "014"
        review_queue_item_id:
          type: string
          x-stream-index: "012"
        target_user:
          $ref: '#/components/schemas/User'
          x-stream-index: "013"
        target_user_id:
          type: string
          x-stream-index: "011"
        type:
          type: string
          x-stream-index: "005"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "007"
      required:
      - id
      - created_at
      - type
      - reason
      - reporter_type
      - custom
      - target_user_id
      - review_queue_item_id
      type: object
    ActionLogResponse:
      nullable: true
      properties:
        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
      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
    AsyncBulkImageModerationEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        finished_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.bulk_image_moderation.success
          type: string
          x-stream-index: "003.002"
        url:
          type: string
          x-stream-index: "001"
      required:
      - url
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncBulkImageModerationEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncExportErrorEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        error:
          type: string
          x-stream-index: "001"
        finished_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.bulk_image_moderation.error
          type: string
          x-stream-index: "003.002"
      required:
      - error
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportErrorEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    AsyncExportModerationLogsEvent:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "003.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003.007"
        finished_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "003.004"
        started_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        task_id:
          type: string
          x-stream-index: "002.001"
        type:
          default: export.moderation_logs.success
          type: string
          x-stream-index: "003.002"
        url:
          type: string
          x-stream-index: "001"
      required:
      - url
      - task_id
      - started_at
      - finished_at
      - type
      - created_at
      - custom
      title: AsyncExportModerationLogsEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    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
    AudioSettings:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "001"
        default_device:
          enum:
          - speaker
          - earpiece
          type: string
          x-stream-index: "006"
        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
      type: object
    AudioSettingsResponse:
      properties:
        access_request_enabled:
          type: boolean
          x-stream-index: "001"
        default_device:
          enum:
          - speaker
          - earpiece
          type: string
          x-stream-index: "006"
        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
      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
    BackstageSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "002"
      required:
      - enabled
      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
    Ban:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "012"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "011"
        expires:
          format: date-time
          type: number
          x-stream-index: "007"
        reason:
          type: string
          x-stream-index: "008"
        shadow:
          type: boolean
          x-stream-index: "009"
        target:
          $ref: '#/components/schemas/User'
          x-stream-index: "006"
      required:
      - shadow
      - created_at
      type: object
    BanActionRequest:
      properties:
        channel_ban_only:
          type: boolean
          x-stream-index: "003"
        delete_messages:
          enum:
          - soft
          - pruning
          - hard
          type: string
          x-stream-index: "005"
        ip_ban:
          type: boolean
          x-stream-index: "004"
        reason:
          type: string
          x-stream-index: "002"
        shadow:
          type: boolean
          x-stream-index: "001"
        timeout:
          format: int32
          type: integer
          x-stream-index: "006"
      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
    BlockListConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/BlockListRule'
          maximum: 10
          type: array
          x-stream-index: "003"
      required:
      - enabled
      - rules
      type: object
    BlockListOptions:
      properties:
        behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: "002"
        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
    BroadcastSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        hls:
          $ref: '#/components/schemas/HLSSettings'
          x-stream-index: "002"
        rtmp:
          $ref: '#/components/schemas/RTMPSettings'
          x-stream-index: "003"
      required:
      - enabled
      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
    BulkImageModerationRequest:
      nullable: true
      properties:
        csv_file:
          description: URL to CSV file containing image URLs to moderate
          title: string
          type: string
          x-stream-index: "001"
      required:
      - csv_file
      type: object
    BulkImageModerationResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        task_id:
          description: ID of the task for processing the bulk image moderation
          title: string
          type: string
          x-stream-index: "001"
      required:
      - task_id
      - duration
      type: object
    Call:
      properties:
        AppPK:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "002"
        Backstage:
          type: boolean
          writeOnly: true
          x-stream-index: "023"
        BlockedUserIDs:
          items:
            type: string
          type: array
          writeOnly: true
          x-stream-index: "018"
        BlockedUsers:
          items:
            $ref: '#/components/schemas/User'
          type: array
          writeOnly: true
          x-stream-index: "019"
        CID:
          type: string
          writeOnly: true
          x-stream-index: "005"
        CallType:
          $ref: '#/components/schemas/CallType'
          x-stream-index: "020"
        ChannelCID:
          type: string
          writeOnly: true
          x-stream-index: "032"
        CreatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "013"
        CreatedBy:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        CreatedByUserID:
          type: string
          writeOnly: true
          x-stream-index: "007"
        CurrentSessionID:
          type: string
          writeOnly: true
          x-stream-index: "024"
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "012"
        DeletedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "028"
        EgressUpdatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "027"
        Egresses:
          items:
            $ref: '#/components/schemas/CallEgress'
          type: array
          writeOnly: true
          x-stream-index: "015"
        EndedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "017"
        ID:
          type: string
          writeOnly: true
          x-stream-index: "004"
        JoinAheadTimeSeconds:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "031"
        LastHeartbeatAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "030"
        LastSessionID:
          type: string
          writeOnly: true
          x-stream-index: "025"
        MemberCount:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "010"
        MemberLookup:
          $ref: '#/components/schemas/MemberLookup'
          x-stream-index: "011"
        Members:
          items:
            $ref: '#/components/schemas/CallMember'
          type: array
          writeOnly: true
          x-stream-index: "009"
        Session:
          $ref: '#/components/schemas/CallSession'
          x-stream-index: "026"
        Settings:
          $ref: '#/components/schemas/CallSettings'
          x-stream-index: "022"
        SettingsOverrides:
          $ref: '#/components/schemas/CallSettings'
          x-stream-index: "021"
        StartsAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "016"
        Team:
          type: string
          writeOnly: true
          x-stream-index: "006"
        ThumbnailURL:
          type: string
          writeOnly: true
          x-stream-index: "029"
        Type:
          type: string
          writeOnly: true
          x-stream-index: "003"
        UpdatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "014"
      required:
      - AppPK
      - Type
      - ID
      - CID
      - Team
      - CreatedByUserID
      - Members
      - Custom
      - CreatedAt
      - UpdatedAt
      - Egresses
      - BlockedUserIDs
      - BlockedUsers
      - Backstage
      - CurrentSessionID
      - LastSessionID
      - ThumbnailURL
      - ChannelCID
      type: object
    CallEgress:
      nullable: true
      properties:
        app_pk:
          format: int32
          type: integer
          x-stream-index: "002"
        call_id:
          type: string
          x-stream-index: "004"
        call_type:
          type: string
          x-stream-index: "003"
        config:
          $ref: '#/components/schemas/EgressTaskConfig'
          x-stream-index: "007"
        egress_id:
          type: string
          x-stream-index: "005"
        egress_type:
          type: string
          x-stream-index: "006"
        instance_ip:
          type: string
          x-stream-index: "008"
        started_at:
          format: date-time
          type: number
          x-stream-index: "010"
        state:
          type: string
          x-stream-index: "009"
        stopped_at:
          format: date-time
          type: number
          x-stream-index: "011"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "012"
      required:
      - app_pk
      - call_type
      - call_id
      - egress_id
      - egress_type
      - instance_ip
      - state
      - started_at
      - updated_at
      type: object
    CallIngressResponse:
      description: CallIngressResponse is the payload for ingress settings
      properties:
        rtmp:
          $ref: '#/components/schemas/RTMPIngress'
          title: RTMP
          x-stream-index: "001"
      required:
      - rtmp
      title: CallIngressResponse
      type: object
    CallMember:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "010"
        role:
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - user_id
      - role
      - custom
      - created_at
      - updated_at
      type: object
    CallParticipant:
      nullable: true
      properties:
        JoinedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "004"
        Role:
          type: string
          writeOnly: true
          x-stream-index: "002"
        UserSessionID:
          type: string
          writeOnly: true
          x-stream-index: "003"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "001.017"
        banned:
          type: boolean
          x-stream-index: "001.016"
        created_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.006"
        deactivated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.014"
        deleted_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.013"
        id:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "001.023"
        language:
          type: string
          x-stream-index: "001.035"
        last_active:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.011"
        last_engaged_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.012"
        online:
          readOnly: true
          type: boolean
          x-stream-index: "001.022"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "001.026"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "001.042"
        role:
          type: string
          x-stream-index: "001.004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.005"
        updated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.009"
      required:
      - id
      - role
      - teams_role
      - custom
      - banned
      - online
      - Role
      - UserSessionID
      - JoinedAt
      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: "016"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "018"
        captioning:
          type: boolean
          x-stream-index: "013"
        channel_cid:
          type: string
          x-stream-index: "024"
        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: "021"
        ended_at:
          description: Date/time when the call ended
          format: date-time
          title: Ended At
          type: number
          x-stream-index: "014"
        id:
          description: Call ID
          title: ID
          type: string
          x-stream-index: "003"
        ingress:
          $ref: '#/components/schemas/CallIngressResponse'
          x-stream-index: "019"
        join_ahead_time_seconds:
          format: int32
          type: integer
          x-stream-index: "023"
        recording:
          type: boolean
          x-stream-index: "011"
        session:
          $ref: '#/components/schemas/CallSessionResponse'
          x-stream-index: "020"
        settings:
          $ref: '#/components/schemas/CallSettingsResponse'
          x-stream-index: "017"
        starts_at:
          description: Date/time when the call will start
          format: date-time
          title: Starts At
          type: number
          x-stream-index: "015"
        team:
          type: string
          x-stream-index: "006"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailResponse'
          x-stream-index: "022"
        transcribing:
          type: boolean
          x-stream-index: "012"
        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
      - backstage
      - settings
      - blocked_user_ids
      - ingress
      - egress
      title: CallResponse
      type: object
    CallSession:
      properties:
        AcceptedBy:
          additionalProperties:
            format: date-time
            type: number
          type: object
          writeOnly: true
          x-stream-index: "008"
        ActiveSFUs:
          items:
            $ref: '#/components/schemas/SFUIDLastSeen'
          type: array
          writeOnly: true
          x-stream-index: "016"
        AnonymousParticipantCount:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "019"
        AppPK:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "002.001"
        CallID:
          type: string
          writeOnly: true
          x-stream-index: "002.003"
        CallType:
          type: string
          writeOnly: true
          x-stream-index: "002.002"
        CreatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "003"
        DeletedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "004"
        EndedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "006"
        LiveEndedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "013"
        LiveStartedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "012"
        MissedBy:
          additionalProperties:
            format: date-time
            type: number
          type: object
          writeOnly: true
          x-stream-index: "010"
        Participants:
          items:
            $ref: '#/components/schemas/CallParticipant'
          type: array
          writeOnly: true
          x-stream-index: "011"
        ParticipantsCountByRole:
          additionalProperties:
            format: int32
            type: integer
          type: object
          writeOnly: true
          x-stream-index: "018"
        RejectedBy:
          additionalProperties:
            format: date-time
            type: number
          type: object
          writeOnly: true
          x-stream-index: "009"
        RingAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "007"
        SFUIDs:
          items:
            type: string
          type: array
          writeOnly: true
          x-stream-index: "015"
        SessionID:
          type: string
          writeOnly: true
          x-stream-index: "002.004"
        StartedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "005"
        TimerEndsAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "014"
        UserPermissionOverrides:
          additionalProperties:
            additionalProperties:
              type: boolean
            type: object
          type: object
          writeOnly: true
          x-stream-index: "017"
      required:
      - AppPK
      - CallType
      - CallID
      - SessionID
      - CreatedAt
      - AcceptedBy
      - RejectedBy
      - MissedBy
      - Participants
      - SFUIDs
      - ActiveSFUs
      - UserPermissionOverrides
      - ParticipantsCountByRole
      - AnonymousParticipantCount
      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
    CallSettings:
      properties:
        audio:
          $ref: '#/components/schemas/AudioSettings'
          x-stream-index: "001"
        backstage:
          $ref: '#/components/schemas/BackstageSettings'
          x-stream-index: "002"
        broadcasting:
          $ref: '#/components/schemas/BroadcastSettings'
          x-stream-index: "007"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordSettings'
          x-stream-index: "006"
        geofencing:
          $ref: '#/components/schemas/GeofenceSettings'
          x-stream-index: "008"
        limits:
          $ref: '#/components/schemas/LimitsSettings'
          x-stream-index: "012"
        recording:
          $ref: '#/components/schemas/RecordSettings'
          x-stream-index: "005"
        ring:
          $ref: '#/components/schemas/RingSettings'
          x-stream-index: "010"
        screensharing:
          $ref: '#/components/schemas/ScreensharingSettings'
          x-stream-index: "004"
        session:
          $ref: '#/components/schemas/SessionSettings'
          x-stream-index: "013"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailsSettings'
          x-stream-index: "011"
        transcription:
          $ref: '#/components/schemas/TranscriptionSettings'
          x-stream-index: "009"
        video:
          $ref: '#/components/schemas/VideoSettings'
          x-stream-index: "003"
      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: "006"
        geofencing:
          $ref: '#/components/schemas/GeofenceSettingsResponse'
          x-stream-index: "004"
        limits:
          $ref: '#/components/schemas/LimitsSettingsResponse'
          x-stream-index: "012"
        recording:
          $ref: '#/components/schemas/RecordSettingsResponse'
          x-stream-index: "005"
        ring:
          $ref: '#/components/schemas/RingSettingsResponse'
          x-stream-index: "007"
        screensharing:
          $ref: '#/components/schemas/ScreensharingSettingsResponse'
          x-stream-index: "008"
        session:
          $ref: '#/components/schemas/SessionSettingsResponse'
          x-stream-index: "013"
        thumbnails:
          $ref: '#/components/schemas/ThumbnailsSettingsResponse'
          x-stream-index: "011"
        transcription:
          $ref: '#/components/schemas/TranscriptionSettingsResponse'
          x-stream-index: "009"
        video:
          $ref: '#/components/schemas/VideoSettingsResponse'
          x-stream-index: "010"
      required:
      - audio
      - backstage
      - broadcasting
      - geofencing
      - recording
      - frame_recording
      - ring
      - screensharing
      - transcription
      - video
      - thumbnails
      - limits
      - session
      type: object
    CallType:
      properties:
        AppPK:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "003"
        CreatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "005"
        ExternalStorage:
          type: string
          writeOnly: true
          x-stream-index: "009"
        Name:
          type: string
          writeOnly: true
          x-stream-index: "004"
        NotificationSettings:
          $ref: '#/components/schemas/NotificationSettings'
          x-stream-index: "008"
        PK:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "002"
        Settings:
          $ref: '#/components/schemas/CallSettings'
          x-stream-index: "007"
        UpdatedAt:
          format: date-time
          type: number
          writeOnly: true
          x-stream-index: "006"
      required:
      - PK
      - AppPK
      - Name
      - CreatedAt
      - UpdatedAt
      - ExternalStorage
      type: object
    Channel:
      properties:
        active_live_locations:
          items:
            $ref: '#/components/schemas/SharedLocation'
          type: array
          x-stream-index: "034"
        auto_translation_enabled:
          type: boolean
          x-stream-index: "029"
        auto_translation_language:
          type: string
          x-stream-index: "030"
        cid:
          type: string
          x-stream-index: "003"
        config:
          $ref: '#/components/schemas/ChannelConfig'
          x-stream-index: "026"
        config_overrides:
          $ref: '#/components/schemas/ConfigOverrides'
          x-stream-index: "027"
        cooldown:
          format: int32
          type: integer
          x-stream-index: "031"
        created_at:
          format: date-time
          type: number
          x-stream-index: "009"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "019"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "011"
        disabled:
          type: boolean
          x-stream-index: "017"
        frozen:
          type: boolean
          x-stream-index: "016"
        id:
          type: string
          x-stream-index: "004"
        invites:
          items:
            $ref: '#/components/schemas/ChannelMember'
          type: array
          x-stream-index: "022"
        last_campaigns:
          type: string
          x-stream-index: "032"
        last_message_at:
          format: date-time
          type: number
          x-stream-index: "006"
        member_count:
          format: int32
          type: integer
          x-stream-index: "021"
        members:
          items:
            $ref: '#/components/schemas/ChannelMember'
          type: array
          x-stream-index: "020"
        team:
          type: string
          x-stream-index: "028"
        truncated_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "015"
        type:
          type: string
          x-stream-index: "005"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "010"
      required:
      - cid
      - id
      - type
      - created_at
      - updated_at
      - frozen
      - disabled
      - custom
      - auto_translation_language
      type: object
    ChannelConfig:
      properties:
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: "001.026"
        automod:
          enum:
          - disabled
          - simple
          - AI
          type: string
          x-stream-index: "001.021"
        automod_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: "001.022"
        automod_thresholds:
          $ref: '#/components/schemas/Thresholds'
          x-stream-index: "001.027"
        blocklist:
          type: string
          x-stream-index: "001.023"
        blocklist_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: "001.024"
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListOptions'
          type: array
          x-stream-index: "001.025"
        commands:
          items:
            type: string
          type: array
          x-stream-index: "003"
        connect_events:
          type: boolean
          x-stream-index: "001.004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.003"
        custom_events:
          type: boolean
          x-stream-index: "001.012"
        mark_messages_pending:
          type: boolean
          x-stream-index: "001.015"
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: "001.020"
        mutes:
          type: boolean
          x-stream-index: "001.009"
        name:
          type: string
          x-stream-index: "001.001"
        partition_size:
          format: int32
          type: integer
          x-stream-index: "001.028"
        partition_ttl:
          type: integer
          x-stream-index: "001.029"
        polls:
          type: boolean
          x-stream-index: "001.016"
        push_notifications:
          type: boolean
          x-stream-index: "001.013"
        quotes:
          type: boolean
          x-stream-index: "001.008"
        reactions:
          type: boolean
          x-stream-index: "001.006"
        read_events:
          type: boolean
          x-stream-index: "001.003"
        reminders:
          type: boolean
          x-stream-index: "001.014"
        replies:
          type: boolean
          x-stream-index: "001.007"
        search:
          type: boolean
          x-stream-index: "001.005"
        shared_locations:
          type: boolean
          x-stream-index: "001.018"
        skip_last_msg_update_for_system_msgs:
          type: boolean
          x-stream-index: "001.030"
        typing_events:
          type: boolean
          x-stream-index: "001.002"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "002.004"
        uploads:
          type: boolean
          x-stream-index: "001.010"
        url_enrichment:
          type: boolean
          x-stream-index: "001.011"
        user_message_reminders:
          type: boolean
          x-stream-index: "001.017"
      required:
      - name
      - typing_events
      - read_events
      - connect_events
      - search
      - reactions
      - replies
      - quotes
      - mutes
      - uploads
      - url_enrichment
      - custom_events
      - push_notifications
      - reminders
      - mark_messages_pending
      - polls
      - user_message_reminders
      - shared_locations
      - message_retention
      - max_message_length
      - automod
      - automod_behavior
      - skip_last_msg_update_for_system_msgs
      - created_at
      - updated_at
      - commands
      type: object
    ChannelConfigWithInfo:
      properties:
        allowed_flag_reasons:
          items:
            type: string
          type: array
          x-stream-index: 001.002.026
        automod:
          enum:
          - disabled
          - simple
          - AI
          type: string
          x-stream-index: 001.002.021
        automod_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.022
        automod_thresholds:
          $ref: '#/components/schemas/Thresholds'
          x-stream-index: 001.002.027
        blocklist:
          type: string
          x-stream-index: 001.002.023
        blocklist_behavior:
          enum:
          - flag
          - block
          - shadow_block
          type: string
          x-stream-index: 001.002.024
        blocklists:
          items:
            $ref: '#/components/schemas/BlockListOptions'
          type: array
          x-stream-index: 001.002.025
        commands:
          items:
            $ref: '#/components/schemas/Command'
          type: array
          x-stream-index: "001.003"
        connect_events:
          type: boolean
          x-stream-index: 001.002.004
        created_at:
          format: date-time
          type: number
          x-stream-index: 001.001.003
        custom_events:
          type: boolean
          x-stream-index: 001.002.012
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "002"
        mark_messages_pending:
          type: boolean
          x-stream-index: 001.002.015
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: 001.002.020
        mutes:
          type: boolean
          x-stream-index: 001.002.009
        name:
          type: string
          x-stream-index: 001.002.001
        partition_size:
          format: int32
          type: integer
          x-stream-index: 001.002.028
        partition_ttl:
          type: integer
          x-stream-index: 001.002.029
        polls:
          type: boolean
          x-stream-index: 001.002.016
        push_notifications:
          type: boolean
          x-stream-index: 001.002.013
        quotes:
          type: boolean
          x-stream-index: 001.002.008
        reactions:
          type: boolean
          x-stream-index: 001.002.006
        read_events:
          type: boolean
          x-stream-index: 001.002.003
        reminders:
          type: boolean
          x-stream-index: 001.002.014
        replies:
          type: boolean
          x-stream-index: 001.002.007
        search:
          type: boolean
          x-stream-index: 001.002.005
        shared_locations:
          type: boolean
          x-stream-index: 001.002.018
        skip_last_msg_update_for_system_msgs:
          type: boolean
          x-stream-index: 001.002.030
        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.010
        url_enrichment:
          type: boolean
          x-stream-index: 001.002.011
        user_message_reminders:
          type: boolean
          x-stream-index: 001.002.017
      required:
      - created_at
      - updated_at
      - name
      - typing_events
      - read_events
      - connect_events
      - search
      - reactions
      - replies
      - quotes
      - mutes
      - uploads
      - url_enrichment
      - custom_events
      - push_notifications
      - reminders
      - mark_messages_pending
      - polls
      - user_message_reminders
      - shared_locations
      - message_retention
      - max_message_length
      - automod
      - automod_behavior
      - skip_last_msg_update_for_system_msgs
      - commands
      type: object
    ChannelMember:
      nullable: true
      properties:
        archived_at:
          format: date-time
          type: number
          x-stream-index: "021"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "017"
        banned:
          type: boolean
          x-stream-index: "016"
        channel_role:
          type: string
          x-stream-index: "024"
        created_at:
          format: date-time
          type: number
          x-stream-index: "012"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "014"
        invite_accepted_at:
          format: date-time
          type: number
          x-stream-index: "009"
        invite_rejected_at:
          format: date-time
          type: number
          x-stream-index: "010"
        invited:
          type: boolean
          x-stream-index: "008"
        is_global_banned:
          type: boolean
          x-stream-index: "020"
        is_moderator:
          type: boolean
          x-stream-index: "007"
        notifications_muted:
          type: boolean
          x-stream-index: "026"
        pinned_at:
          format: date-time
          type: number
          x-stream-index: "022"
        shadow_banned:
          type: boolean
          x-stream-index: "019"
        status:
          type: string
          x-stream-index: "011"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "013"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - custom
      - created_at
      - updated_at
      - banned
      - shadow_banned
      - is_global_banned
      - channel_role
      - notifications_muted
      type: object
    ChannelMute:
      nullable: true
      properties:
        channel:
          $ref: '#/components/schemas/ChannelResponse'
          x-stream-index: "007"
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "009"
        expires:
          description: Date/time of mute expiration
          format: date-time
          title: Expires
          type: number
          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/User'
          description: Owner of channel mute
          title: User
          x-stream-index: "005"
      required:
      - created_at
      - updated_at
      type: object
    ChannelResponse:
      properties:
        auto_translation_enabled:
          type: boolean
          x-stream-index: "021"
        auto_translation_language:
          type: string
          x-stream-index: "022"
        blocked:
          type: boolean
          x-stream-index: "027"
        cid:
          type: string
          x-stream-index: "005"
        config:
          $ref: '#/components/schemas/ChannelConfigWithInfo'
          x-stream-index: "017"
        cooldown:
          format: int32
          type: integer
          x-stream-index: "024"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "011"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "030"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "010"
        disabled:
          type: boolean
          x-stream-index: "013"
        frozen:
          type: boolean
          x-stream-index: "012"
        hidden:
          type: boolean
          x-stream-index: "026"
        hide_messages_before:
          format: date-time
          type: number
          x-stream-index: "023"
        id:
          type: string
          x-stream-index: "003"
        last_message_at:
          format: date-time
          type: number
          x-stream-index: "006"
        member_count:
          format: int32
          type: integer
          x-stream-index: "015"
        members:
          items:
            $ref: '#/components/schemas/ChannelMember'
          type: array
          x-stream-index: "014"
        mute_expires_at:
          format: date-time
          type: number
          x-stream-index: "019"
        muted:
          type: boolean
          x-stream-index: "018"
        own_capabilities:
          items:
            type: string
          type: array
          x-stream-index: "025"
        team:
          type: string
          x-stream-index: "020"
        truncated_at:
          format: date-time
          type: number
          x-stream-index: "028"
        truncated_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "029"
        type:
          type: string
          x-stream-index: "004"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
      required:
      - id
      - type
      - cid
      - created_at
      - updated_at
      - frozen
      - disabled
      - custom
      type: object
    CheckRequest:
      nullable: true
      properties:
        config_key:
          description: Key of the moderation configuration to use
          title: Config Key
          type: string
          x-stream-index: "005"
        config_team:
          description: Team associated with the configuration
          title: Config Team
          type: string
          x-stream-index: "006"
        entity_creator_id:
          description: ID of the user who created the entity
          title: Entity Creator ID
          type: string
          x-stream-index: "003"
        entity_id:
          description: Unique identifier of the entity to moderate
          title: Entity ID
          type: string
          x-stream-index: "002"
        entity_type:
          description: Type of entity to moderate
          title: Entity Type
          type: string
          x-stream-index: "001"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          description: Content to be moderated
          title: Moderation Payload
          x-stream-index: "004"
        options:
          additionalProperties: {}
          description: Additional moderation configuration options
          title: Options
          type: object
          x-stream-index: "007"
        test_mode:
          description: Whether to run moderation in test mode
          title: Test Mode
          type: boolean
          x-stream-index: "008"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "009.002"
        user_id:
          type: string
          x-stream-index: "009.001"
      required:
      - entity_type
      - entity_id
      - entity_creator_id
      - config_key
      type: object
    CheckResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "005.001"
        item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: Review queue item (present if action != keep)
          title: Item
          x-stream-index: "004"
        recommended_action:
          description: Suggested action based on moderation results
          title: Recommended Action
          type: string
          x-stream-index: "003"
        status:
          description: Status of the moderation check (completed or pending)
          title: Status
          type: string
          x-stream-index: "001"
        task_id:
          description: ID of the running moderation task
          title: Task ID
          type: string
          x-stream-index: "002"
      required:
      - status
      - recommended_action
      - duration
      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
    CompositeAppSettings:
      properties:
        json_encoded_settings:
          type: string
          x-stream-index: "005"
        url:
          type: string
          x-stream-index: "004"
      type: object
    ConfigOverrides:
      properties:
        blocklist:
          type: string
          x-stream-index: "008"
        blocklist_behavior:
          enum:
          - flag
          - block
          type: string
          x-stream-index: "009"
        commands:
          items:
            type: string
          type: array
          x-stream-index: "011"
        grants:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "010"
        max_message_length:
          format: int32
          maximum: 20000
          type: integer
          x-stream-index: "007"
        quotes:
          type: boolean
          x-stream-index: "004"
        reactions:
          type: boolean
          x-stream-index: "002"
        replies:
          type: boolean
          x-stream-index: "003"
        shared_locations:
          type: boolean
          x-stream-index: "013"
        typing_events:
          type: boolean
          x-stream-index: "001"
        uploads:
          type: boolean
          x-stream-index: "005"
        url_enrichment:
          type: boolean
          x-stream-index: "006"
        user_message_reminders:
          type: boolean
          x-stream-index: "012"
      required:
      - grants
      - commands
      type: object
    ConfigResponse:
      properties:
        ai_image_config:
          $ref: '#/components/schemas/AIImageConfig'
          description: Configuration for AI image analysis
          title: AI Image Config
          x-stream-index: "009"
        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: "010"
        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: "012"
        key:
          description: Unique identifier for the moderation configuration
          title: Key
          type: string
          x-stream-index: "001"
        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: "013"
        velocity_filter_config:
          $ref: '#/components/schemas/VelocityFilterConfig'
          description: Configuration for velocity-based filtering
          title: Velocity Filter Config
          x-stream-index: "011"
        video_call_rule_config:
          $ref: '#/components/schemas/VideoCallRuleConfig'
          x-stream-index: "014"
      required:
      - key
      - team
      - async
      - created_at
      - updated_at
      type: object
    CustomActionRequest:
      properties:
        id:
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
      type: object
    CustomCheckFlag:
      properties:
        custom:
          additionalProperties: {}
          description: Additional metadata for the flag
          title: Custom
          type: object
          x-stream-index: "003"
        labels:
          description: Labels from various moderation sources
          items:
            type: string
          title: Labels
          type: array
          x-stream-index: "004"
        reason:
          description: Optional explanation for the flag
          title: Reason
          type: string
          x-stream-index: "002"
        type:
          description: Type of check (custom_check_text, custom_check_image, custom_check_video)
          maxLength: 255
          title: Type
          type: string
          x-stream-index: "001"
      required:
      - type
      type: object
    CustomCheckRequest:
      nullable: true
      properties:
        entity_creator_id:
          description: ID of the user who created the entity (required for non-message
            entities)
          title: Entity Creator ID
          type: string
          x-stream-index: "003"
        entity_id:
          description: Unique identifier of the entity
          title: Entity ID
          type: string
          x-stream-index: "002"
        entity_type:
          description: Type of entity to perform custom check on
          title: Entity Type
          type: string
          x-stream-index: "001"
        flags:
          description: List of custom check flags (1-10 flags required)
          items:
            $ref: '#/components/schemas/CustomCheckFlag'
          maximum: 10
          minimum: 1
          title: Flags
          type: array
          x-stream-index: "005"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          description: Content to be checked (required for non-message entities)
          title: Moderation Payload
          x-stream-index: "004"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "006.002"
        user_id:
          type: string
          x-stream-index: "006.001"
      required:
      - entity_type
      - entity_id
      - flags
      type: object
    CustomCheckResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "004.001"
        id:
          description: Unique identifier of the custom check
          title: ID
          type: string
          x-stream-index: "001"
        item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: Review queue item details
          title: Item
          x-stream-index: "002"
        status:
          description: Status of the custom check
          title: Status
          type: string
          x-stream-index: "003"
      required:
      - id
      - status
      - duration
      type: object
    Data:
      properties:
        id:
          type: string
          x-stream-index: "001"
      required:
      - id
      type: object
    DeleteActivityRequest:
      properties:
        hard_delete:
          type: boolean
          x-stream-index: "001"
      type: object
    DeleteMessageRequest:
      properties:
        hard_delete:
          type: boolean
          x-stream-index: "001"
      type: object
    DeleteModerationConfigResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    DeleteModerationTemplateResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    DeleteReactionRequest:
      properties:
        hard_delete:
          type: boolean
          x-stream-index: "001"
      type: object
    DeleteUserRequest:
      properties:
        delete_conversation_channels:
          type: boolean
          x-stream-index: "003"
        delete_feeds_content:
          type: boolean
          x-stream-index: "004"
        hard_delete:
          type: boolean
          x-stream-index: "001"
        mark_messages_deleted:
          type: boolean
          x-stream-index: "002"
      type: object
    Device:
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "002.002"
        disabled:
          type: boolean
          x-stream-index: "002.003"
        disabled_reason:
          type: string
          x-stream-index: "002.004"
        id:
          type: string
          x-stream-index: 002.001.004
        push_provider:
          enum:
          - firebase
          - apn
          - huawei
          - xiaomi
          type: string
          x-stream-index: 002.001.001
        push_provider_name:
          type: string
          x-stream-index: 002.001.003
        user_id:
          type: string
          x-stream-index: "004"
        voip:
          type: boolean
          x-stream-index: 002.001.005
      required:
      - push_provider
      - id
      - created_at
      - user_id
      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:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "004"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "007"
        html:
          type: string
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "001"
        mentioned_users:
          items:
            $ref: '#/components/schemas/UserResponse'
          type: array
          x-stream-index: "008"
        mml:
          type: string
          x-stream-index: "003"
        parent_id:
          type: string
          x-stream-index: "005"
        poll_id:
          type: string
          x-stream-index: "013"
        quoted_message_id:
          type: string
          x-stream-index: "009"
        show_in_channel:
          type: boolean
          x-stream-index: "006"
        silent:
          type: boolean
          x-stream-index: "012"
        text:
          type: string
          x-stream-index: "002"
        type:
          type: string
          x-stream-index: "011"
      required:
      - id
      - text
      - custom
      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"
        frame_recording:
          $ref: '#/components/schemas/FrameRecordingResponse'
          x-stream-index: "004"
        hls:
          $ref: '#/components/schemas/EgressHLSResponse'
          x-stream-index: "002"
        rtmps:
          items:
            $ref: '#/components/schemas/EgressRTMPResponse'
          type: array
          x-stream-index: "003"
      required:
      - broadcasting
      - rtmps
      type: object
    EgressTaskConfig:
      properties:
        egress_user:
          $ref: '#/components/schemas/EgressUser'
          x-stream-index: "008"
        frame_recording_egress_config:
          $ref: '#/components/schemas/FrameRecordingEgressConfig'
          x-stream-index: "009"
        hls_egress_config:
          $ref: '#/components/schemas/HLSEgressConfig'
          x-stream-index: "007"
        recording_egress_config:
          $ref: '#/components/schemas/RecordingEgressConfig'
          x-stream-index: "006"
        rtmp_egress_config:
          $ref: '#/components/schemas/RTMPEgressConfig'
          x-stream-index: "004"
        stt_egress_config:
          $ref: '#/components/schemas/STTEgressConfig'
          x-stream-index: "005"
      type: object
    EgressUser:
      properties:
        token:
          type: string
          x-stream-index: "004"
      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
    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
    EntityCreator:
      properties:
        ban_count:
          format: int32
          type: integer
          x-stream-index: "002"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "001.017"
        banned:
          type: boolean
          x-stream-index: "001.016"
        created_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.006"
        deactivated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.014"
        deleted_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.013"
        deleted_content_count:
          format: int32
          type: integer
          x-stream-index: "003"
        id:
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "001.023"
        language:
          type: string
          x-stream-index: "001.035"
        last_active:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.011"
        last_engaged_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.012"
        online:
          readOnly: true
          type: boolean
          x-stream-index: "001.022"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "001.026"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "001.042"
        role:
          type: string
          x-stream-index: "001.004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "001.036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001.005"
        updated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "001.009"
      required:
      - id
      - role
      - teams_role
      - custom
      - banned
      - online
      - ban_count
      - deleted_content_count
      type: object
    EntityCreatorResponse:
      properties:
        ban_count:
          description: Number of minor actions performed on the user
          format: int32
          title: Ban Count
          type: integer
          x-stream-index: "002"
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "001.003"
        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"
        devices:
          items:
            $ref: '#/components/schemas/DeviceResponse'
          type: array
          x-stream-index: "001.006"
        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
        invisible:
          type: boolean
          x-stream-index: "001.007"
        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
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          x-stream-index: "001.005"
        push_notifications:
          $ref: '#/components/schemas/PushNotificationSettingsResponse'
          x-stream-index: "001.004"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: 001.001.015
        role:
          type: string
          x-stream-index: 001.001.006
        shadow_banned:
          type: boolean
          x-stream-index: "001.002"
        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
    EventNotificationSettings:
      properties:
        apns:
          $ref: '#/components/schemas/APNS'
          x-stream-index: "002"
        enabled:
          type: boolean
          x-stream-index: "001"
        fcm:
          $ref: '#/components/schemas/FCM'
          x-stream-index: "003"
      required:
      - enabled
      - apns
      - fcm
      type: object
    ExternalStorage:
      properties:
        abs_account_name:
          type: string
          x-stream-index: "011"
        abs_client_id:
          type: string
          x-stream-index: "013"
        abs_client_secret:
          type: string
          x-stream-index: "014"
        abs_tenant_id:
          type: string
          x-stream-index: "012"
        bucket:
          type: string
          x-stream-index: "005"
        gcs_credentials:
          type: string
          x-stream-index: "010"
        path:
          type: string
          x-stream-index: "006"
        s3_api_key:
          type: string
          x-stream-index: "007"
        s3_custom_endpoint:
          type: string
          x-stream-index: "016"
        s3_region:
          type: string
          x-stream-index: "009"
        s3_secret_key:
          type: string
          x-stream-index: "008"
        storage_name:
          type: string
          x-stream-index: "015"
        storage_type:
          type: integer
          x-stream-index: "004"
      type: object
    FCM:
      properties:
        data:
          additionalProperties: {}
          type: object
          x-stream-index: "001"
      type: object
    FeedsModerationTemplateConfig:
      properties:
        config_key:
          type: string
          x-stream-index: "002"
        data_types:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "001"
      required:
      - data_types
      - config_key
      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
    Flag:
      description: Contains information about flagged user or message
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "019"
        custom:
          additionalProperties: {}
          description: Additional metadata about the flag
          title: Custom
          type: object
          x-stream-index: "014"
        entity_creator_id:
          description: ID of the user who created the flagged entity
          title: Entity Creator ID
          type: string
          x-stream-index: "009"
        entity_id:
          description: Unique identifier of the entity being flagged
          title: Entity ID
          type: string
          x-stream-index: "008"
        entity_type:
          description: Type of entity being flagged (e.g., message, user)
          title: Entity Type
          type: string
          x-stream-index: "007"
        is_streamed_content:
          type: boolean
          x-stream-index: "012"
        labels:
          description: Labels from bodyguard, API calls, our own AI etc
          items:
            type: string
          title: Labels
          type: array
          x-stream-index: "015"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          description: Content being flagged
          title: Moderation Payload
          x-stream-index: "010"
        moderation_payload_hash:
          type: string
          x-stream-index: "011"
        reason:
          description: Optional explanation for why the content is being flagged
          title: Reason
          type: string
          x-stream-index: "013"
        result:
          description: Result of bodyguard, API calls, our own AI etc
          items:
            additionalProperties: {}
            type: object
          title: Result
          type: array
          x-stream-index: "016"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItem'
          x-stream-index: "018"
        review_queue_item_id:
          description: ID of the review queue item
          title: Review Queue Item ID
          type: string
          x-stream-index: "017"
        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: "020"
        user:
          $ref: '#/components/schemas/User'
          description: User who flagged a message or a user
          title: User
          x-stream-index: "006"
      required:
      - entity_type
      - entity_id
      - result
      - created_at
      - updated_at
      title: Flag
      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"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "007.002"
        user_id:
          type: string
          x-stream-index: "007.001"
      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
    FrameRecordSettings:
      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
    FrameRecordingEgressConfig:
      properties:
        capture_interval_in_seconds:
          format: int32
          type: integer
          x-stream-index: "007"
        external_storage:
          $ref: '#/components/schemas/ExternalStorage'
          x-stream-index: "006"
        quality:
          $ref: '#/components/schemas/Quality'
          x-stream-index: "004"
        storage_name:
          type: string
          x-stream-index: "005"
      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
    GeofenceSettings:
      properties:
        names:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - names
      type: object
    GeofenceSettingsResponse:
      properties:
        names:
          items:
            type: string
          type: array
          x-stream-index: "001"
      required:
      - names
      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
    GetReviewQueueItemResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: Current state of the review queue item
          title: Item
          x-stream-index: "001"
      required:
      - duration
      type: object
    GoogleVisionConfig:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    HLSEgressConfig:
      properties:
        composite_app_settings:
          $ref: '#/components/schemas/CompositeAppSettings'
          x-stream-index: "005"
        playlist_url:
          type: string
          x-stream-index: "007"
        qualities:
          items:
            $ref: '#/components/schemas/Quality'
          type: array
          x-stream-index: "004"
        start_unix_nano:
          format: int64
          type: integer
          x-stream-index: "006"
      type: object
    HLSSettings:
      properties:
        auto_on:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        layout:
          $ref: '#/components/schemas/LayoutSettings'
          x-stream-index: "004"
        quality_tracks:
          items:
            type: string
          type: array
          x-stream-index: "003"
      required:
      - auto_on
      - enabled
      - quality_tracks
      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"
        layout:
          $ref: '#/components/schemas/LayoutSettingsResponse'
          title: Layout
          x-stream-index: "004"
        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"
        severity:
          type: integer
          x-stream-index: "002"
      required:
      - action_sequences
      - severity
      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
    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
    LabelThresholds:
      properties:
        block:
          format: float
          maximum: 1
          minimum: 0
          type: number
          x-stream-index: "002"
        flag:
          format: float
          maximum: 1
          minimum: 0
          type: number
          x-stream-index: "001"
      type: object
    LayoutSettings:
      properties:
        detect_orientation:
          type: boolean
          x-stream-index: "005"
        external_app_url:
          type: string
          x-stream-index: "003"
        external_css_url:
          type: string
          x-stream-index: "004"
        name:
          enum:
          - spotlight
          - grid
          - single-participant
          - mobile
          - custom
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
      required:
      - name
      - external_app_url
      - external_css_url
      type: object
    LayoutSettingsResponse:
      properties:
        detect_orientation:
          type: boolean
          x-stream-index: "005"
        external_app_url:
          type: string
          x-stream-index: "003"
        external_css_url:
          type: string
          x-stream-index: "004"
        name:
          enum:
          - spotlight
          - grid
          - single-participant
          - mobile
          - custom
          type: string
          x-stream-index: "001"
        options:
          additionalProperties: {}
          type: object
          x-stream-index: "002"
      required:
      - name
      - external_app_url
      - external_css_url
      type: object
    LimitsSettings:
      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
    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
    MarkReviewedRequest:
      properties:
        content_to_mark_as_reviewed_limit:
          format: int32
          maximum: 2500
          type: integer
          x-stream-index: "002"
        disable_marking_content_as_reviewed:
          type: boolean
          x-stream-index: "001"
      type: object
    MemberLookup:
      properties:
        Limit:
          format: int32
          type: integer
          writeOnly: true
          x-stream-index: "001"
      required:
      - Limit
      type: object
    Message:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/Attachment'
          type: array
          x-stream-index: "012"
        before_message_send_failed:
          type: boolean
          x-stream-index: "046"
        cid:
          type: string
          x-stream-index: "028"
        command:
          type: string
          x-stream-index: "006"
        created_at:
          format: date-time
          type: number
          x-stream-index: "030"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "034"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "033"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "023"
        html:
          type: string
          x-stream-index: "007"
        i18n:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "044"
        id:
          type: string
          x-stream-index: "002"
        image_labels:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          x-stream-index: "040"
        latest_reactions:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
          x-stream-index: "013"
        mentioned_users:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "043"
        message_text_updated_at:
          format: date-time
          type: number
          x-stream-index: "052"
        mml:
          type: string
          x-stream-index: "005"
        moderation:
          $ref: '#/components/schemas/ModerationV2Response'
          x-stream-index: "056"
        own_reactions:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
          x-stream-index: "014"
        parent_id:
          type: string
          x-stream-index: "019"
        pin_expires:
          format: date-time
          type: number
          x-stream-index: "051"
        pinned:
          type: boolean
          x-stream-index: "047"
        pinned_at:
          format: date-time
          type: number
          x-stream-index: "048"
        pinned_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "050"
        poll:
          $ref: '#/components/schemas/Poll'
          x-stream-index: "054"
        poll_id:
          type: string
          x-stream-index: "053"
        quoted_message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "025"
        quoted_message_id:
          type: string
          x-stream-index: "024"
        reaction_counts:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "015"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "017"
        reaction_scores:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "016"
        reminder:
          $ref: '#/components/schemas/MessageReminder'
          x-stream-index: "058"
        reply_count:
          format: int32
          type: integer
          x-stream-index: "022"
        restricted_visibility:
          items:
            type: string
          type: array
          x-stream-index: "011"
        shadowed:
          type: boolean
          x-stream-index: "036"
        shared_location:
          $ref: '#/components/schemas/SharedLocation'
          x-stream-index: "055"
        show_in_channel:
          type: boolean
          x-stream-index: "021"
        silent:
          type: boolean
          x-stream-index: "045"
        text:
          type: string
          x-stream-index: "004"
        thread_participants:
          items:
            $ref: '#/components/schemas/User'
          type: array
          x-stream-index: "027"
        type:
          type: string
          x-stream-index: "008"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "031"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "010"
      required:
      - id
      - text
      - html
      - type
      - restricted_visibility
      - attachments
      - latest_reactions
      - own_reactions
      - reaction_counts
      - reaction_scores
      - reaction_groups
      - reply_count
      - deleted_reply_count
      - cid
      - created_at
      - updated_at
      - custom
      - shadowed
      - mentioned_users
      - silent
      - pinned
      type: object
    MessageReminder:
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "004"
        channel_cid:
          type: string
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "011"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "006"
        message_id:
          type: string
          x-stream-index: "005"
        remind_at:
          format: date-time
          type: number
          x-stream-index: "009"
        task_id:
          type: string
          x-stream-index: "010"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "012"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "008"
        user_id:
          type: string
          x-stream-index: "007"
      required:
      - channel_cid
      - message_id
      - user_id
      - task_id
      - created_at
      - updated_at
      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: "008"
        cid:
          description: Channel unique identifier in <type>:<id> format
          title: Channel CID
          type: string
          x-stream-index: "022"
        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: "023"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "026"
        deleted_at:
          description: Date/time of deletion
          format: date-time
          title: Deleted at
          type: number
          x-stream-index: "025"
        deleted_reply_count:
          format: int32
          type: integer
          x-stream-index: "018"
        draft:
          $ref: '#/components/schemas/DraftResponse'
          x-stream-index: "041"
        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: "030"
        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: "028"
        latest_reactions:
          description: List of 10 latest reactions to this message
          items:
            $ref: '#/components/schemas/ReactionResponse'
          title: Latest reactions
          type: array
          x-stream-index: "009"
        mentioned_users:
          description: List of mentioned users
          items:
            $ref: '#/components/schemas/UserResponse'
          title: Mentioned Users
          type: array
          x-stream-index: "029"
        message_text_updated_at:
          format: date-time
          type: number
          x-stream-index: "036"
        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: "039"
        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: "010"
        parent_id:
          description: ID of parent message (thread)
          title: Parent message ID
          type: string
          x-stream-docs-page-id: threads
          x-stream-index: "015"
        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: "035"
        pinned:
          description: Whether message is pinned or not
          title: Pinned
          type: boolean
          x-stream-docs-page-id: pinned_messages
          x-stream-index: "032"
        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: "033"
        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: "034"
        poll:
          $ref: '#/components/schemas/PollResponseData'
          x-stream-index: "038"
        poll_id:
          description: Identifier of the poll to include in the message
          title: Poll ID
          type: string
          x-stream-index: "037"
        quoted_message:
          $ref: '#/components/schemas/MessageResponse'
          description: Contains quoted message
          title: Quoted message
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "020"
        quoted_message_id:
          title: ID of quoted message
          type: string
          x-stream-docs-page-id: threads#quote-message
          x-stream-index: "019"
        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: "011"
        reaction_groups:
          additionalProperties:
            $ref: '#/components/schemas/ReactionGroupResponse'
          type: object
          x-stream-index: "014"
        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: "012"
        reminder:
          $ref: '#/components/schemas/ReminderResponseData'
          x-stream-index: "042"
        reply_count:
          description: Number of replies to this message
          format: int32
          title: Reply count
          type: integer
          x-stream-index: "017"
        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: "040"
        shadowed:
          description: Whether the message was shadowed or not
          title: Shadowed
          type: boolean
          x-stream-docs-page-id: moderation#shadow-ban
          x-stream-index: "027"
        shared_location:
          $ref: '#/components/schemas/SharedLocationResponseData'
          description: Contains shared location data
          title: Shared Location
          x-stream-index: "043"
        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: "016"
        silent:
          description: Whether message is silent or not
          title: Silent
          type: boolean
          x-stream-index: "031"
        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: "021"
        type:
          description: Contains type of the message
          enum:
          - 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: "024"
        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
      - silent
      - pinned
      - restricted_visibility
      title: Message
      type: object
      x-stream-docs-page-id: send_message
    ModerationActionConfig:
      nullable: true
      properties:
        action:
          type: string
          x-stream-index: "006"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "009"
        description:
          type: string
          x-stream-index: "008"
        entity_type:
          type: string
          x-stream-index: "004"
        icon:
          type: string
          x-stream-index: "007"
        order:
          format: int32
          type: integer
          x-stream-index: "005"
      required:
      - entity_type
      - order
      - action
      - icon
      - description
      - custom
      type: object
    ModerationCheckCompletedEvent:
      description: This event is sent when a moderation check is completed
      nullable: true
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        entity_id:
          description: The ID of entity which was moderated
          title: EntityID
          type: string
          x-stream-index: "002"
        entity_type:
          description: The type of the entity which was moderated
          title: EntityType
          type: string
          x-stream-index: "003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
        recommended_action:
          description: The recommended action
          title: RecommendedAction
          type: string
          x-stream-index: "004"
        review_queue_item_id:
          description: The review queue item ID
          title: ReviewQueueItemID
          type: string
          x-stream-index: "005"
        type:
          default: moderation_check.completed
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      - entity_id
      - entity_type
      - recommended_action
      - review_queue_item_id
      title: ModerationCheckCompletedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationCustomActionEvent:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004.002"
        item:
          $ref: '#/components/schemas/ReviewQueueItem'
          x-stream-index: "001"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "002"
        type:
          default: moderation.custom_action
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      title: ModerationCustomActionEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationFlagResponse:
      nullable: true
      properties:
        created_at:
          type: string
          x-stream-index: "014"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "009"
        entity_creator_id:
          type: string
          x-stream-index: "006"
        entity_id:
          type: string
          x-stream-index: "005"
        entity_type:
          type: string
          x-stream-index: "004"
        id:
          type: string
          x-stream-index: "001"
        labels:
          items:
            type: string
          type: array
          x-stream-index: "010"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          x-stream-index: "007"
        reason:
          type: string
          x-stream-index: "008"
        result:
          items:
            additionalProperties: {}
            type: object
          type: array
          x-stream-index: "011"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          x-stream-index: "013"
        review_queue_item_id:
          type: string
          x-stream-index: "012"
        type:
          type: string
          x-stream-index: "002"
        updated_at:
          type: string
          x-stream-index: "015"
        user:
          $ref: '#/components/schemas/UserResponse'
          x-stream-index: "003"
      required:
      - id
      - type
      - entity_type
      - entity_id
      - created_at
      - updated_at
      type: object
    ModerationFlaggedEvent:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004.002"
        item:
          type: string
          x-stream-index: "001"
        object_id:
          type: string
          x-stream-index: "002"
        type:
          default: moderation.flagged
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      title: ModerationFlaggedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationMarkReviewedEvent:
      properties:
        created_at:
          format: date-time
          type: number
          x-stream-index: "004.002"
        item:
          $ref: '#/components/schemas/ReviewQueueItem'
          x-stream-index: "001"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "002"
        type:
          default: moderation.mark_reviewed
          type: string
          x-stream-index: "004.001"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "003.001"
      required:
      - type
      - created_at
      title: ModerationMarkReviewedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ModerationPayload:
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "004"
        images:
          items:
            type: string
          maximum: 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
    ModerationV2Response:
      properties:
        action:
          type: string
          x-stream-index: "001"
        blocklist_matched:
          type: string
          x-stream-index: "005"
        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: "007"
        semantic_filter_matched:
          type: string
          x-stream-index: "006"
        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"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "003.002"
        user_id:
          type: string
          x-stream-index: "003.001"
      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/UserMute'
          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/OwnUser'
          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
    NotificationSettings:
      properties:
        call_live_started:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "002"
        call_missed:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "006"
        call_notification:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "004"
        call_ring:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "005"
        enabled:
          type: boolean
          x-stream-index: "001"
        session_started:
          $ref: '#/components/schemas/EventNotificationSettings'
          x-stream-index: "003"
      required:
      - enabled
      - call_live_started
      - session_started
      - call_notification
      - call_ring
      - call_missed
      type: object
    NullTime:
      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
    OwnUser:
      properties:
        banned:
          type: boolean
          x-stream-index: "016"
        blocked_user_ids:
          items:
            type: string
          type: array
          x-stream-index: "045"
        channel_mutes:
          items:
            $ref: '#/components/schemas/ChannelMute'
          type: array
          x-stream-index: "029"
        created_at:
          format: date-time
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deactivated_at:
          format: date-time
          type: number
          x-stream-index: "014"
        deleted_at:
          format: date-time
          type: number
          x-stream-index: "013"
        devices:
          items:
            $ref: '#/components/schemas/Device'
          type: array
          x-stream-index: "027"
        id:
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "023"
        language:
          type: string
          x-stream-index: "035"
        last_active:
          format: date-time
          type: number
          x-stream-index: "011"
        last_engaged_at:
          format: date-time
          type: number
          x-stream-index: "012"
        latest_hidden_channels:
          items:
            type: string
          type: array
          x-stream-index: "037"
        mutes:
          items:
            $ref: '#/components/schemas/UserMute'
          type: array
          x-stream-index: "028"
        online:
          type: boolean
          x-stream-index: "022"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "026"
        push_preferences:
          $ref: '#/components/schemas/PushPreferences'
          x-stream-index: "025"
        role:
          type: string
          x-stream-index: "004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "005"
        total_unread_count:
          format: int32
          type: integer
          x-stream-index: "031"
        total_unread_count_by_team:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "032"
        unread_channels:
          format: int32
          type: integer
          x-stream-index: "033"
        unread_count:
          format: int32
          type: integer
          x-stream-index: "030"
        unread_threads:
          format: int32
          type: integer
          x-stream-index: "034"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "009"
      required:
      - id
      - role
      - custom
      - created_at
      - updated_at
      - banned
      - online
      - devices
      - mutes
      - channel_mutes
      - unread_count
      - total_unread_count
      - total_unread_count_by_team
      - unread_channels
      - unread_threads
      - language
      type: object
    Poll:
      properties:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "023"
        allow_answers:
          type: boolean
          x-stream-index: "010"
        allow_user_suggested_options:
          type: boolean
          x-stream-index: "009"
        answers_count:
          format: int32
          type: integer
          x-stream-index: "015"
        created_at:
          format: date-time
          type: number
          x-stream-index: "021"
        created_by:
          $ref: '#/components/schemas/User'
          x-stream-index: "020"
        created_by_id:
          type: string
          x-stream-index: "019"
        description:
          type: string
          x-stream-index: "005"
        enforce_unique_vote:
          type: boolean
          x-stream-index: "007"
        id:
          type: string
          x-stream-index: "003"
        is_closed:
          type: boolean
          x-stream-index: "011"
        latest_answers:
          items:
            $ref: '#/components/schemas/PollVote'
          type: array
          x-stream-index: "017"
        latest_votes_by_option:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PollVote'
            type: array
          type: object
          x-stream-index: "016"
        max_votes_allowed:
          format: int32
          type: integer
          x-stream-index: "008"
        name:
          type: string
          x-stream-index: "004"
        options:
          items:
            $ref: '#/components/schemas/PollOption'
          type: array
          x-stream-index: "013"
        own_votes:
          items:
            $ref: '#/components/schemas/PollVote'
          type: array
          x-stream-index: "018"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "022"
        vote_count:
          format: int32
          type: integer
          x-stream-index: "012"
        vote_counts_by_option:
          additionalProperties:
            format: int32
            type: integer
          type: object
          x-stream-index: "014"
        voting_visibility:
          type: string
          x-stream-index: "006"
      required:
      - id
      - name
      - description
      - enforce_unique_vote
      - allow_user_suggested_options
      - allow_answers
      - vote_count
      - options
      - vote_counts_by_option
      - answers_count
      - latest_votes_by_option
      - latest_answers
      - own_votes
      - created_by_id
      - created_at
      - updated_at
      - Custom
      type: object
    PollOption:
      nullable: true
      properties:
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "003"
        id:
          maxLength: 255
          type: string
          x-stream-index: "001"
        text:
          type: string
          x-stream-index: "002"
      required:
      - id
      - text
      - custom
      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:
        Custom:
          additionalProperties: {}
          type: object
          writeOnly: true
          x-stream-index: "021"
        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"
        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
    PollVote:
      nullable: true
      properties:
        answer_text:
          type: string
          x-stream-index: "007"
        created_at:
          format: date-time
          type: number
          x-stream-index: "010"
        id:
          type: string
          x-stream-index: "004"
        is_answer:
          type: boolean
          x-stream-index: "006"
        option_id:
          type: string
          x-stream-index: "005"
        poll_id:
          type: string
          x-stream-index: "003"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "011"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "009"
        user_id:
          type: string
          x-stream-index: "008"
      required:
      - poll_id
      - id
      - option_id
      - created_at
      - updated_at
      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
    PrivacySettings:
      properties:
        read_receipts:
          $ref: '#/components/schemas/ReadReceipts'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicators'
          x-stream-index: "001"
      type: object
    PrivacySettingsResponse:
      properties:
        read_receipts:
          $ref: '#/components/schemas/ReadReceiptsResponse'
          x-stream-index: "002"
        typing_indicators:
          $ref: '#/components/schemas/TypingIndicatorsResponse'
          x-stream-index: "001"
      type: object
    PushNotificationSettingsResponse:
      properties:
        disabled:
          type: boolean
          x-stream-index: "001"
        disabled_until:
          format: date-time
          type: number
          x-stream-index: "002"
      type: object
    PushPreferences:
      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: "003"
      type: object
    Quality:
      properties:
        bitdepth:
          format: int32
          type: integer
          x-stream-index: "007"
        framerate:
          format: int32
          type: integer
          x-stream-index: "008"
        height:
          format: int32
          type: integer
          x-stream-index: "006"
        name:
          type: string
          x-stream-index: "004"
        video_bitrate:
          format: int32
          type: integer
          x-stream-index: "009"
        width:
          format: int32
          type: integer
          x-stream-index: "005"
      type: object
    QueryFeedModerationTemplate:
      properties:
        config:
          $ref: '#/components/schemas/FeedsModerationTemplateConfig'
          description: Configuration for the moderation template
          title: Config
          x-stream-index: "002"
        created_at:
          description: When the template was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "003"
        name:
          description: Name of the moderation template
          title: Name
          type: string
          x-stream-index: "001"
        updated_at:
          description: When the template was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "004"
      required:
      - name
      - created_at
      - updated_at
      type: object
    QueryFeedModerationTemplatesResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.001"
        templates:
          description: List of moderation templates
          items:
            $ref: '#/components/schemas/QueryFeedModerationTemplate'
          title: Templates
          type: array
          x-stream-index: "001"
      required:
      - templates
      - 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"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "004.002"
        user_id:
          type: string
          x-stream-index: "004.001"
      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
    QueryModerationFlagsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          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:
          items:
            $ref: '#/components/schemas/SortParam'
          type: array
          x-stream-index: "002"
      type: object
    QueryModerationFlagsResponse:
      description: Basic response information
      nullable: true
      properties:
        duration:
          description: Duration of the request in milliseconds
          title: Duration
          type: string
          x-stream-index: "003.001"
        flags:
          items:
            $ref: '#/components/schemas/ModerationFlagResponse'
          type: array
          x-stream-index: "001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - flags
      - duration
      title: Response
      type: object
    QueryModerationLogsRequest:
      nullable: true
      properties:
        filter:
          additionalProperties: {}
          description: Filter conditions for moderation logs
          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"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "004.002"
        user_id:
          type: string
          x-stream-index: "004.001"
      type: object
    QueryModerationLogsResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "003.001"
        logs:
          description: List of moderation action logs
          items:
            $ref: '#/components/schemas/ActionLogResponse'
          title: Logs
          type: array
          x-stream-index: "001"
        next:
          type: string
          x-stream-index: "002.001"
        prev:
          type: string
          x-stream-index: "002.002"
      required:
      - logs
      - 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"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "008.002"
        user_id:
          type: string
          x-stream-index: "008.001"
      type: object
    QueryReviewQueueResponse:
      nullable: true
      properties:
        action_config:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ModerationActionConfig'
            type: array
          description: Configuration for moderation actions
          title: Action Config
          type: object
          x-stream-index: "002"
        duration:
          type: string
          x-stream-index: "005.001"
        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: "004.001"
        prev:
          type: string
          x-stream-index: "004.002"
        stats:
          additionalProperties: {}
          description: Statistics about the review queue
          title: Stats
          type: object
          x-stream-index: "003"
      required:
      - items
      - action_config
      - stats
      - duration
      type: object
    RTMPEgressConfig:
      properties:
        composite_app_settings:
          $ref: '#/components/schemas/CompositeAppSettings'
          x-stream-index: "005"
        quality:
          $ref: '#/components/schemas/Quality'
          x-stream-index: "004"
        rtmp_location:
          type: string
          x-stream-index: "006"
      type: object
    RTMPIngress:
      description: RTMP input settings
      properties:
        address:
          title: Address
          type: string
          x-stream-index: "001"
      required:
      - address
      title: RTMPIngress
      type: object
    RTMPLocation:
      properties:
        name:
          type: string
          x-stream-index: "001"
        stream_key:
          type: string
          x-stream-index: "003"
        stream_url:
          type: string
          x-stream-index: "002"
      required:
      - name
      - stream_url
      - stream_key
      type: object
    RTMPSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettings'
          x-stream-index: "003"
        location:
          $ref: '#/components/schemas/RTMPLocation'
          x-stream-index: "004"
        quality_name:
          type: string
          x-stream-index: "002"
      required:
      - enabled
      type: object
    RTMPSettingsResponse:
      description: RTMPSettingsResponse is the payload for RTMP settings
      properties:
        enabled:
          title: Enabled
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettingsResponse'
          title: Layout
          x-stream-index: "003"
        quality:
          title: Quality
          type: string
          x-stream-index: "002"
      required:
      - enabled
      - quality
      - layout
      title: RTMPSettingsResponse
      type: object
    Reaction:
      nullable: true
      properties:
        created_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "010"
        message_id:
          type: string
          x-stream-index: "003"
        score:
          format: int32
          type: integer
          x-stream-index: "007"
        type:
          maxLength: 30
          type: string
          x-stream-index: "006"
        updated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "009"
        user:
          $ref: '#/components/schemas/User'
          x-stream-index: "005"
        user_id:
          type: string
          x-stream-index: "004"
      required:
      - message_id
      - type
      - score
      - created_at
      - updated_at
      - custom
      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
    ReadReceipts:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    ReadReceiptsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    RecordSettings:
      properties:
        audio_only:
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettings'
          x-stream-index: "004"
        mode:
          type: string
          x-stream-index: "002"
        quality:
          type: string
          x-stream-index: "003"
      required:
      - mode
      type: object
    RecordSettingsResponse:
      description: RecordSettings is the payload for recording settings
      properties:
        audio_only:
          title: Audio Only
          type: boolean
          x-stream-index: "001"
        layout:
          $ref: '#/components/schemas/LayoutSettingsResponse'
          title: Layout
          x-stream-index: "004"
        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
    RecordingEgressConfig:
      properties:
        audio_only:
          type: boolean
          x-stream-index: "006"
        composite_app_settings:
          $ref: '#/components/schemas/CompositeAppSettings'
          x-stream-index: "005"
        external_storage:
          $ref: '#/components/schemas/ExternalStorage'
          x-stream-index: "008"
        quality:
          $ref: '#/components/schemas/Quality'
          x-stream-index: "004"
        storage_name:
          type: string
          x-stream-index: "007"
        video_orientation_hint:
          $ref: '#/components/schemas/VideoOrientation'
          x-stream-index: "009"
      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/Message'
          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/User'
          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
    RestoreActionRequest:
      type: object
    ReviewQueueItem:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ActionLog'
          type: array
          x-stream-index: "035"
        activity:
          $ref: '#/components/schemas/EnrichedActivity'
          x-stream-index: "028"
        ai_text_severity:
          type: string
          x-stream-index: "021"
        assigned_to:
          $ref: '#/components/schemas/User'
          x-stream-index: "032"
        bans:
          items:
            $ref: '#/components/schemas/Ban'
          type: array
          x-stream-index: "033"
        bounce_count:
          format: int32
          type: integer
          x-stream-index: "025"
        call:
          $ref: '#/components/schemas/Call'
          x-stream-index: "031"
        completed_at:
          $ref: '#/components/schemas/NullTime'
          x-stream-index: "018"
        config_key:
          type: string
          x-stream-index: "009"
        content_changed:
          type: boolean
          x-stream-index: "036"
        created_at:
          format: date-time
          type: number
          x-stream-index: "004"
        entity_creator:
          $ref: '#/components/schemas/EntityCreator'
          x-stream-index: "030"
        entity_id:
          type: string
          x-stream-index: "007"
        entity_type:
          type: string
          x-stream-index: "006"
        feeds_v2_activity:
          $ref: '#/components/schemas/EnrichedActivity'
          x-stream-index: "041"
        feeds_v2_reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "042"
        flags:
          items:
            $ref: '#/components/schemas/Flag'
          type: array
          x-stream-index: "034"
        flags_count:
          format: int32
          type: integer
          x-stream-index: "026"
        has_image:
          type: boolean
          x-stream-index: "012"
        has_text:
          type: boolean
          x-stream-index: "014"
        has_video:
          type: boolean
          x-stream-index: "013"
        id:
          type: string
          x-stream-index: "003"
        languages:
          items:
            type: string
          type: array
          x-stream-index: "019"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "027"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          x-stream-index: "010"
        moderation_payload_hash:
          type: string
          x-stream-index: "011"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "029"
        recommended_action:
          type: string
          x-stream-index: "017"
        reviewed_at:
          $ref: '#/components/schemas/NullTime'
          x-stream-index: "022"
        reviewed_by:
          type: string
          x-stream-index: "023"
        severity:
          format: int32
          type: integer
          x-stream-index: "020"
        status:
          type: string
          x-stream-index: "016"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "015"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "005"
      required:
      - id
      - created_at
      - updated_at
      - entity_type
      - entity_id
      - config_key
      - moderation_payload_hash
      - has_image
      - has_video
      - has_text
      - teams
      - status
      - recommended_action
      - completed_at
      - languages
      - severity
      - ai_text_severity
      - reviewed_at
      - reviewed_by
      - bounce_count
      - flags_count
      - bans
      - flags
      - actions
      - content_changed
      type: object
    ReviewQueueItemNewEvent:
      description: This event is sent when a new moderation review queue item is created
      nullable: true
      properties:
        action:
          $ref: '#/components/schemas/ActionLogResponse'
          description: The action log if any action was taken
          title: Action
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        flags:
          description: The flags associated with this review queue item
          items:
            $ref: '#/components/schemas/FlagResponse'
          title: Flags
          type: array
          x-stream-index: "003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item that was created
          title: ReviewQueueItem
          x-stream-index: "002"
        type:
          default: review_queue_item.new
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: ReviewQueueItemNewEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    ReviewQueueItemResponse:
      properties:
        actions:
          description: Moderation actions taken
          items:
            $ref: '#/components/schemas/ActionLogResponse'
          title: Actions
          type: array
          x-stream-index: "024"
        activity:
          $ref: '#/components/schemas/EnrichedActivity'
          x-stream-index: "016"
        ai_text_severity:
          description: AI-determined text severity
          title: AI Text Severity
          type: string
          x-stream-index: "014"
        assigned_to:
          $ref: '#/components/schemas/UserResponse'
          description: Moderator assigned to review this item
          title: Assigned To
          x-stream-index: "021"
        bans:
          description: Associated ban records
          items:
            $ref: '#/components/schemas/Ban'
          title: Bans
          type: array
          x-stream-index: "022"
        call:
          $ref: '#/components/schemas/CallResponse'
          x-stream-index: "018"
        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: "028"
        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: "019"
        entity_creator_id:
          description: ID of who created the entity
          title: Entity Creator ID
          type: string
          x-stream-index: "020"
        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: "025"
        feeds_v2_reaction:
          $ref: '#/components/schemas/Reaction'
          description: Associated feed reaction
          title: Feeds V2 Reaction
          x-stream-index: "026"
        flags:
          description: Associated flag records
          items:
            $ref: '#/components/schemas/FlagResponse'
          title: Flags
          type: array
          x-stream-index: "023"
        flags_count:
          format: int32
          type: integer
          x-stream-index: "029"
        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"
        message:
          $ref: '#/components/schemas/MessageResponse'
          description: Associated message details
          title: Message
          x-stream-index: "015"
        moderation_payload:
          $ref: '#/components/schemas/ModerationPayload'
          description: Content being moderated
          title: Moderation Payload
          x-stream-index: "006"
        reaction:
          $ref: '#/components/schemas/Reaction'
          x-stream-index: "017"
        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: "027"
        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
      - bans
      - flags
      - actions
      - flags_count
      type: object
    ReviewQueueItemUpdatedEvent:
      description: This event is sent when a moderation review queue item is updated
      nullable: true
      properties:
        action:
          $ref: '#/components/schemas/ActionLogResponse'
          description: The action log if any action was taken
          title: Action
          x-stream-index: "004"
        created_at:
          format: date-time
          type: number
          x-stream-index: "001.003"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "001.007"
        flags:
          description: The flags associated with this review queue item
          items:
            $ref: '#/components/schemas/FlagResponse'
          title: Flags
          type: array
          x-stream-index: "003"
        received_at:
          format: date-time
          type: number
          x-stream-index: "001.004"
        review_queue_item:
          $ref: '#/components/schemas/ReviewQueueItemResponse'
          description: The review queue item that was updated
          title: ReviewQueueItem
          x-stream-index: "002"
        type:
          default: review_queue_item.updated
          type: string
          x-stream-index: "001.002"
      required:
      - type
      - created_at
      - custom
      title: ReviewQueueItemUpdatedEvent
      type: object
      x-stream-event-client-type: true
      x-stream-event-doc-group: other
      x-stream-is-event: true
      x-stream-ws-base-event-name: VideoEvent
    RingSettings:
      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
    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:
        duration:
          format: int32
          type: integer
          x-stream-index: "002"
        ip_ban:
          type: boolean
          x-stream-index: "005"
        reason:
          type: string
          x-stream-index: "003"
        shadow_ban:
          type: boolean
          x-stream-index: "004"
        type:
          type: string
          x-stream-index: "001"
      type: object
    RuleBuilderCondition:
      properties:
        labels:
          items:
            type: string
          type: array
          x-stream-index: "002"
        provider:
          type: string
          x-stream-index: "001"
        threshold:
          format: int32
          type: integer
          x-stream-index: "003"
        time_window:
          type: string
          x-stream-index: "004"
      type: object
    RuleBuilderConfig:
      properties:
        async:
          type: boolean
          x-stream-index: "001"
        enabled:
          type: boolean
          x-stream-index: "002"
        rules:
          items:
            $ref: '#/components/schemas/RuleBuilderRule'
          type: array
          x-stream-index: "003"
      type: object
    RuleBuilderRule:
      properties:
        action:
          $ref: '#/components/schemas/RuleBuilderAction'
          x-stream-index: "004"
        conditions:
          items:
            $ref: '#/components/schemas/RuleBuilderCondition'
          type: array
          x-stream-index: "003"
        enabled:
          type: boolean
          x-stream-index: "005"
        id:
          type: string
          x-stream-index: "001"
        name:
          type: string
          x-stream-index: "002"
      type: object
    SFUIDLastSeen:
      properties:
        id:
          type: string
          x-stream-index: "001.001"
        last_seen:
          format: date-time
          type: number
          x-stream-index: "002"
        process_start_time:
          format: int64
          type: integer
          x-stream-index: "001.002"
      required:
      - id
      - process_start_time
      - last_seen
      type: object
    STTEgressConfig:
      properties:
        closed_captions_enabled:
          type: boolean
          x-stream-index: "005"
        external_storage:
          $ref: '#/components/schemas/ExternalStorage'
          x-stream-index: "011"
        language:
          type: string
          x-stream-index: "008"
        storage_name:
          type: string
          x-stream-index: "010"
        translation_languages:
          items:
            type: string
          type: array
          x-stream-index: "009"
        translations_enabled:
          type: boolean
          x-stream-index: "006"
        upload_transcriptions:
          type: boolean
          x-stream-index: "004"
        whisper_server_base_url:
          type: string
          x-stream-index: "007"
      type: object
    ScreensharingSettings:
      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
    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
    SessionSettings:
      properties:
        inactivity_timeout_seconds:
          format: int32
          maximum: 900
          minimum: 5
          type: integer
          x-stream-index: "001"
      required:
      - inactivity_timeout_seconds
      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
    ShadowBlockActionRequest:
      type: object
    SharedLocation:
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
          x-stream-index: "013"
        channel_cid:
          type: string
          x-stream-index: "003"
        created_at:
          format: date-time
          type: number
          x-stream-index: "010"
        created_by_device_id:
          type: string
          x-stream-index: "008"
        end_at:
          format: date-time
          type: number
          x-stream-index: "009"
        latitude:
          format: float
          maximum: 90
          minimum: 1.8446744073709552e+19
          type: number
          x-stream-index: "006"
        longitude:
          format: float
          maximum: 180
          minimum: 1.8446744073709552e+19
          type: number
          x-stream-index: "007"
        message:
          $ref: '#/components/schemas/Message'
          x-stream-index: "012"
        message_id:
          type: string
          x-stream-index: "004"
        updated_at:
          format: date-time
          type: number
          x-stream-index: "011"
        user_id:
          type: string
          x-stream-index: "005"
      required:
      - channel_cid
      - message_id
      - user_id
      - created_by_device_id
      - created_at
      - updated_at
      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
    SortParam:
      nullable: true
      properties:
        direction:
          format: int32
          type: integer
          x-stream-index: "002"
        field:
          type: string
          x-stream-index: "001"
      type: object
    SortParamRequest:
      nullable: true
      properties:
        direction:
          description: Direction of sorting, 1 for Ascending, -1 for Descending, default
            is 1
          format: int32
          title: Direction
          type: integer
          x-stream-index: "002"
        field:
          description: Name of field to sort by
          title: Field
          type: string
          x-stream-index: "001"
      type: object
    SubmitActionRequest:
      nullable: true
      properties:
        action_type:
          description: Type of moderation action to perform (mark_reviewed, delete_message,
            etc.)
          enum:
          - mark_reviewed
          - delete_message
          - delete_activity
          - delete_reaction
          - ban
          - custom
          - unban
          - restore
          - delete_user
          - unblock
          - shadow_block
          - kick_user
          - end_call
          title: Action Type
          type: string
          x-stream-index: "002"
        ban:
          $ref: '#/components/schemas/BanActionRequest'
          description: Configuration for ban action
          title: Ban
          x-stream-index: "008"
        custom:
          $ref: '#/components/schemas/CustomActionRequest'
          description: Configuration for custom action
          title: Custom
          x-stream-index: "009"
        delete_activity:
          $ref: '#/components/schemas/DeleteActivityRequest'
          description: Configuration for activity deletion action
          title: Delete Activity
          x-stream-index: "004"
        delete_message:
          $ref: '#/components/schemas/DeleteMessageRequest'
          description: Configuration for message deletion action
          title: Delete Message
          x-stream-index: "003"
        delete_reaction:
          $ref: '#/components/schemas/DeleteReactionRequest'
          description: Configuration for reaction deletion action
          title: Delete Reaction
          x-stream-index: "005"
        delete_user:
          $ref: '#/components/schemas/DeleteUserRequest'
          description: Configuration for user deletion action
          title: Delete User
          x-stream-index: "006"
        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/MarkReviewedRequest'
          description: Configuration for marking item as reviewed
          title: Mark Reviewed
          x-stream-index: "007"
        unban:
          $ref: '#/components/schemas/UnbanActionRequest'
          description: Configuration for unban action
          title: Unban
          x-stream-index: "010"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "016.002"
        user_id:
          type: string
          x-stream-index: "016.001"
      required:
      - item_id
      - action_type
      type: object
    SubmitActionResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.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
    Thresholds:
      properties:
        explicit:
          $ref: '#/components/schemas/LabelThresholds'
          x-stream-index: "001"
        spam:
          $ref: '#/components/schemas/LabelThresholds'
          x-stream-index: "002"
        toxic:
          $ref: '#/components/schemas/LabelThresholds'
          x-stream-index: "003"
      type: object
    ThumbnailResponse:
      properties:
        image_url:
          type: string
          x-stream-index: "001"
      required:
      - image_url
      type: object
    ThumbnailsSettings:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    ThumbnailsSettingsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    Time:
      type: object
    TranscriptionSettings:
      properties:
        closed_caption_mode:
          enum:
          - available
          - disabled
          - auto-on
          title: Mode
          type: string
          x-stream-index: "002"
        language:
          description: The language used in this call as a two letter code
          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
          title: Language
          type: string
          x-stream-index: "004"
        mode:
          enum:
          - available
          - disabled
          - auto-on
          title: Mode
          type: string
          x-stream-index: "001"
      required:
      - mode
      - closed_caption_mode
      - languages
      - language
      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"
      required:
      - mode
      - closed_caption_mode
      - languages
      - language
      type: object
    TypingIndicators:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      required:
      - enabled
      type: object
    TypingIndicatorsResponse:
      properties:
        enabled:
          type: boolean
          x-stream-index: "001"
      type: object
    UnbanActionRequest:
      type: object
    UnbanRequest:
      nullable: true
      properties:
        unbanned_by:
          $ref: '#/components/schemas/UserRequest'
          description: Details about the user performing the unban
          title: Unbanned By
          x-stream-index: "005"
        unbanned_by_id:
          description: ID of the user performing the unban
          title: Unbanned By ID
          type: string
          x-stream-index: "004"
      type: object
    UnbanResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "001.001"
      required:
      - duration
      type: object
    UnblockActionRequest:
      type: object
    UnmuteRequest:
      nullable: true
      properties:
        target_ids:
          description: User IDs to unmute
          items:
            type: string
          title: Target IDs
          type: array
          x-stream-index: "001"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "002.002"
        user_id:
          type: string
          x-stream-index: "002.001"
      required:
      - target_ids
      title: UnmuteRequest
      type: object
    UnmuteResponse:
      nullable: true
      properties:
        duration:
          type: string
          x-stream-index: "002.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: "001"
      required:
      - duration
      title: UnmuteResponse
      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: "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"
        aws_rekognition_config:
          $ref: '#/components/schemas/AIImageConfig'
          x-stream-index: "015"
        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: "014"
        google_vision_config:
          $ref: '#/components/schemas/GoogleVisionConfig'
          description: Configuration for Google Vision integration
          title: Google Vision Config
          x-stream-index: "009"
        key:
          description: Unique identifier for the moderation configuration
          title: Key
          type: string
          x-stream-index: "001"
        rule_builder_config:
          $ref: '#/components/schemas/RuleBuilderConfig'
          x-stream-index: "013"
        team:
          description: Team associated with the configuration
          maxLength: 128
          minLength: 1
          title: Team
          type: string
          x-stream-index: "002"
        user:
          $ref: '#/components/schemas/UserRequest'
          x-stream-index: "017.002"
        user_id:
          type: string
          x-stream-index: "017.001"
        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: "016"
      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
    UpsertModerationTemplateRequest:
      nullable: true
      properties:
        config:
          $ref: '#/components/schemas/FeedsModerationTemplateConfig'
          description: Configuration for the moderation template
          title: Config
          x-stream-index: "002"
        name:
          description: Name of the moderation template
          title: Name
          type: string
          x-stream-index: "001"
      required:
      - name
      - config
      type: object
    UpsertModerationTemplateResponse:
      nullable: true
      properties:
        config:
          $ref: '#/components/schemas/FeedsModerationTemplateConfig'
          description: Configuration for the moderation template
          title: Config
          x-stream-index: "002"
        created_at:
          description: When the template was created
          format: date-time
          title: Created At
          type: number
          x-stream-index: "003"
        duration:
          type: string
          x-stream-index: "005.001"
        name:
          description: Name of the moderation template
          title: Name
          type: string
          x-stream-index: "001"
        updated_at:
          description: When the template was last updated
          format: date-time
          title: Updated At
          type: number
          x-stream-index: "004"
      required:
      - name
      - created_at
      - updated_at
      - duration
      type: object
    User:
      properties:
        ban_expires:
          format: date-time
          type: number
          x-stream-index: "017"
        banned:
          type: boolean
          x-stream-index: "016"
        created_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "008"
        custom:
          additionalProperties: {}
          type: object
          x-stream-index: "006"
        deactivated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "014"
        deleted_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "013"
        id:
          type: string
          x-stream-index: "003"
        invisible:
          type: boolean
          x-stream-index: "023"
        language:
          type: string
          x-stream-index: "035"
        last_active:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "011"
        last_engaged_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "012"
        online:
          readOnly: true
          type: boolean
          x-stream-index: "022"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettings'
          x-stream-index: "026"
        revoke_tokens_issued_before:
          format: date-time
          type: number
          x-stream-index: "042"
        role:
          type: string
          x-stream-index: "004"
        teams:
          items:
            type: string
          type: array
          x-stream-index: "036"
        teams_role:
          additionalProperties:
            type: string
          type: object
          x-stream-index: "005"
        updated_at:
          format: date-time
          readOnly: true
          type: number
          x-stream-index: "009"
      required:
      - id
      - role
      - teams_role
      - custom
      - banned
      - online
      type: object
    UserMute:
      nullable: true
      properties:
        created_at:
          description: Date/time of creation
          format: date-time
          title: Created at
          type: number
          x-stream-index: "009"
        expires:
          description: Date/time of mute expiration
          format: date-time
          title: Expires
          type: number
          x-stream-index: "008"
        target:
          $ref: '#/components/schemas/User'
          description: User who's muted
          title: Target
          x-stream-index: "007"
        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/User'
          description: Owner of channel mute
          title: User
          x-stream-index: "005"
      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"
        role:
          description: User's global role
          title: Role
          type: string
          x-stream-index: "008"
        teams:
          description: List of teams the user belongs to
          items:
            type: string
          title: Teams
          type: array
          x-stream-index: "010"
        teams_role:
          additionalProperties:
            type: string
          description: Map of team-specific roles for the user
          title: TeamsRole
          type: object
          x-stream-index: "009"
      required:
      - id
      title: UserRequest
      type: object
    UserResponse:
      description: User response object
      properties:
        ban_expires:
          description: Date when ban expires
          format: date-time
          title: Ban expires
          type: number
          x-stream-index: "003"
        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"
        devices:
          description: List of devices user is using
          items:
            $ref: '#/components/schemas/DeviceResponse'
          title: Devices
          type: array
          x-stream-index: "006"
        id:
          description: Unique user identifier
          title: ID
          type: string
          x-stream-index: "001.001"
        image:
          title: Image
          type: string
          x-stream-index: "001.003"
        invisible:
          type: boolean
          x-stream-index: "007"
        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"
        privacy_settings:
          $ref: '#/components/schemas/PrivacySettingsResponse'
          description: User privacy settings
          title: Privacy settings
          x-stream-index: "005"
        push_notifications:
          $ref: '#/components/schemas/PushNotificationSettingsResponse'
          description: User push notification settings
          title: Push notifications
          x-stream-index: "004"
        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"
        shadow_banned:
          description: Whether a user is shadow banned
          title: Shadow banned
          type: boolean
          x-stream-index: "002"
        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
    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:
        rules:
          additionalProperties:
            $ref: '#/components/schemas/HarmConfig'
          type: object
          x-stream-index: "001"
      required:
      - rules
      type: object
    VideoEndCallRequest:
      type: object
    VideoKickUserRequest:
      type: object
    VideoOrientation:
      properties:
        orientation:
          type: integer
          x-stream-index: "004"
      type: object
    VideoSettings:
      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
    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
    WebhookEvent:
      description: The discriminator object for all webhook events, it maps events'
        payload to the final type
      discriminator:
        mapping:
          export.bulk_image_moderation.error: '#/components/schemas/AsyncExportErrorEvent'
          export.bulk_image_moderation.success: '#/components/schemas/AsyncBulkImageModerationEvent'
          export.moderation_logs.error: '#/components/schemas/AsyncExportErrorEvent'
          export.moderation_logs.success: '#/components/schemas/AsyncExportModerationLogsEvent'
          moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent'
          moderation.flagged: '#/components/schemas/ModerationFlaggedEvent'
          moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent'
          moderation_check.completed: '#/components/schemas/ModerationCheckCompletedEvent'
          review_queue_item.new: '#/components/schemas/ReviewQueueItemNewEvent'
          review_queue_item.updated: '#/components/schemas/ReviewQueueItemUpdatedEvent'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AsyncBulkImageModerationEvent'
      - $ref: '#/components/schemas/AsyncExportErrorEvent'
      - $ref: '#/components/schemas/AsyncExportErrorEvent'
      - $ref: '#/components/schemas/AsyncExportModerationLogsEvent'
      - $ref: '#/components/schemas/ModerationCheckCompletedEvent'
      - $ref: '#/components/schemas/ModerationCustomActionEvent'
      - $ref: '#/components/schemas/ModerationFlaggedEvent'
      - $ref: '#/components/schemas/ModerationMarkReviewedEvent'
      - $ref: '#/components/schemas/ReviewQueueItemNewEvent'
      - $ref: '#/components/schemas/ReviewQueueItemUpdatedEvent'
  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: v183.1.0
openapi: 3.0.3
paths:
  /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/bulk_image_moderation:
    post:
      description: |
        Moderate multiple images in bulk using a CSV file
      operationId: bulk_image_moderation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImageModerationRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkImageModerationResponse'
          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: Bulk image moderation
      tags:
      - product:moderation
  /api/v2/moderation/check:
    post:
      description: |
        Run moderation checks on the provided content
      operationId: check
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckResponse'
          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: Check
      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/custom_check:
    post:
      description: |
        Custom check, add your own AI model reports to the review queue
      operationId: custom_check
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCheckRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCheckResponse'
          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: Custom check endpoint
      tags:
      - product:moderation
  /api/v2/moderation/feeds_moderation_template:
    delete:
      description: |
        Delete a specific moderation template by its name
      operationId: V2DeleteTemplate
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteModerationTemplateResponse'
          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 template
      tags:
      - product:moderation
    get:
      description: |
        Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.
      operationId: V2QueryTemplates
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryFeedModerationTemplatesResponse'
          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 feed moderation templates
      tags:
      - product:moderation
    post:
      description: |
        Upsert feeds template for moderation
      operationId: V2UpsertTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertModerationTemplateRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertModerationTemplateResponse'
          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: Upsert feeds template
      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/flags:
    post:
      description: |
        Query flags associated with moderation items. This is used for building a moderation dashboard.
      operationId: query_moderation_flags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryModerationFlagsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryModerationFlagsResponse'
          description: 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 flags
      tags:
      - product:moderation
  /api/v2/moderation/logs:
    post:
      description: |
        Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.
      operationId: query_moderation_logs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryModerationLogsRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryModerationLogsResponse'
          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 action logs
      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/review_queue/{id}:
    get:
      description: |
        Retrieve a specific review queue item by its ID
      operationId: get_review_queue_item
      parameters:
      - in: path
        name: id
        required: true
        schema:
          description: Unique identifier of the review queue item to retrieve
          title: ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReviewQueueItemResponse'
          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 review queue item
      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
  /api/v2/moderation/unban:
    post:
      description: |
        Unban a user from a channel or globally.
      operationId: unban
      parameters:
      - in: query
        name: target_user_id
        required: true
        schema:
          description: ID of the user to unban
          title: Target User ID
          type: string
          writeOnly: true
          x-stream-index: "001"
      - in: query
        name: channel_cid
        schema:
          description: Channel where the unban applies
          title: Channel CID
          type: string
          writeOnly: true
          x-stream-index: "002"
      - in: query
        name: created_by
        schema:
          description: ID of the user who created the ban
          title: Created By
          type: string
          writeOnly: true
          x-stream-index: "003"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnbanRequest'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnbanResponse'
          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: Unban
      tags:
      - product:moderation
  /api/v2/moderation/unmute:
    post:
      description: |
        Unmute a user
      operationId: unmute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnmuteRequest'
        description: UnmuteRequest
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnmuteResponse'
          description: UnmuteResponse
        "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: Unmute a user
      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