IrisAnywhere API

Create a project

First authenticate, then send the returned bearer token with this and every later request.

POST/api/projects 

  


  

    Open the new asset at https://<iris-host>/irisanywhere/assetpackage/<asset_package_id>
  














  
Authentication

  
Sign in once to get an access_token, then send it with every request.


  

    

      POST/api/authenticate
      
        
          
          
          
        
        
      
    

    

  


  

    

      Header for every other request
      
    

    
Authorization: Bearer <access_token>

  


  

    Using Postman? On the Authorization tab, set Auth type to Bearer Token and put the token in Token, or save it as an environment variable like {{token}}.
  














  
Segment data XML

  
Open a segment data file to edit, or edit the example below. You can import it into an Iris project from the Iris app or through the API (first authenticate).


  

    
       Quick edit
      Edit segment types and annotations without touching the XML
      
    
    

  


  

    

      segment_data.xml
      
        
        
        
        
      
    

    
  

  

  
Editing the XML above updates this request body.


  

    

      POST
      
        
          
          
        
        
      
    

    

  














  

    
Custom QC report

    
Change how Iris's QC report PDF looks, then download the config zip and upload it to Iris Admin.

      The preview uses a sample report, or  one of your own QC reports to see it with real data.

    
  


  

    
    

      

        
Branding

        

          
          

            
            
            
          

        

        

          
          
        

        

          
          
        

      


      

        
Sizes px

        

          
          
          
          
        

      


      

        
Colors

        

          
          
          
          
          
          
          
          
        

      


      

        
Header

        

      


      

        
Sections untick to hide, arrows to reorder

        

      


      

        
Report file

        
These don't change the report itself. They set the report's name in Iris's Generate QC Report menu, and the file name suggested when it's saved.

        

          
          
        

        

          
          
        

      



      

        
        
      


      
      
The zip holds config.json, and an IrisXml_to_IrisPdf folder with IrisXml_to_IrisPdf.xslt and logo.png.

    


    
    

      

        Preview with sample data
        
      

      
      

    

  
















  
QC report XML

  
Open a QC report to edit, or edit the example below. You can import it into an Iris project from the Iris app or through the API (first authenticate).


  

    
       Quick edit
      Edit the asset ID, file paths and annotations without touching the XML
      
    
    

  


  

    

      qc_report.xml
      
        
        
        
        
      
    

    
  

  

  
Editing the XML above updates this request body.


  

    

      POST
      
        
          
          
        
        
      
    

    

  


  

    Each import adds annotations to the asset. It doesn't replace the ones already there, so send it once.

    Keep the <VideoInfo> section. In testing, imports without it added no annotations.