You're looking at a specific version of this model. Jump to the model overview.
            
              
                
              
            
            Input schema
          
        The fields you can use to run this model with an API. If you don’t give a value for a field its default value will be used.
| Field | Type | Default value | Description | 
|---|---|---|---|
| video | 
           
            string
            
           
         | 
        
           
            Input video
           
         | 
      |
| mask | 
           
            string
            
           
         | 
        
           
            Provide the mask for the first frame. You can leave this blank and use SAM to generate the mask below.
           
         | 
      |
| mask_with_SAM | 
           
            string
            
           
         | 
        
           
            Use SAM to generate mask, ignored if a mask_file is provided above. Provide coordinates of the object of interest in the format of `x | y`.
           
         | 
      |
| max_frames | 
           
            integer
            
           
         | 
        
           
            Number of frames to process. Leave this blank to process the entire video.
           
         | 
      |
| inpaint_with_propainter | 
           
            boolean
            
           
         | 
        
          
             
              False
             
          
          
          
         | 
        
           
            Remove the masked objects (inpaint) with ProPainter.
           
         | 
      
| show_overlay_video | 
           
            boolean
            
           
         | 
        
          
             
              False
             
          
          
          
         | 
        
           
            Output the video that overlays the mask on each frame. 
           
         | 
      
            
              
                
              
            
            Output schema
          
        The shape of the response you’ll get when you run this model with an API.
              Schema
            
            {'properties': {'first_mask_with_SAM': {'format': 'uri',
                                        'title': 'First Mask With Sam',
                                        'type': 'string'},
                'inpaint_out': {'format': 'uri',
                                'title': 'Inpaint Out',
                                'type': 'string'},
                'masked_out': {'format': 'uri',
                               'title': 'Masked Out',
                               'type': 'string'},
                'overlay_out': {'format': 'uri',
                                'title': 'Overlay Out',
                                'type': 'string'}},
 'required': ['masked_out'],
 'title': 'ModelOutput',
 'type': 'object'}