Reference Guides
      Back to home
      1. Knowledge Base
      2. Developers
      3. Reference Guides

      Creating a Video Record with the Imagen API 👩‍🏫

      This guide will show you how to create a new record with video media via the Imagen API

      Prerequisite: This article assumes that you have been through the steps to create an application in developer mode. Follow this link if you need to create an application

      The Endpoint 

      https://[The FQDN of your imagen MCC server goes here]:83/imcc/v1/import/record/[Your mapping file goes here]?workflow=Ingest Video

      Video XML Payload

      <?xml version="1.0" encoding="UTF-8"?>

      <Records>

          <ImagenRecord>

              <Fields>

                  <Title>[Title goes here]</Title>

                  <Date>[Date goes here, for example, 0000-00-00]</Date>

                  <Summary><![CDATA[

                     [Summary goes here]

                  ]]></Summary>
                  
              </Fields>

              <MediaObject Version="3" ID="-1" MediaType="Video" IsClip="">  

                  <MediaElement MediaType="Video" Index="0" Umid="">

                      <OriginalFile><![CDATA[

                    [HTTP(s) URL link to file goes here]

                      ]]></OriginalFile>   

                  </MediaElement> 

              </MediaObject>

          </ImagenRecord>
      </Records>

      Video XML Payload with annotations

      ⚠️Warning: If annotations are added they must fit within the media object timeline

      <?xml version="1.0" encoding="UTF-8"?>

      <Records>

          <ImagenRecord>

              <Fields>

                 <Title>[Title goes here]</Title>

                 <Date>[Date goes here, for example, 0000-00-00]</Date>

                  <Summary><![CDATA[

                    [Summary goes here]

                 ]]></Summary>
                 
              </Fields>

              <MediaObject Version="3" ID="-1" MediaType="Video" IsClip="">  

                  <MediaElement MediaType="Video" Index="0" Umid="">

                      <OriginalFile><![CDATA[

                   [HTTP(s) URL link to file goes here]

                      ]]></OriginalFile>   

                  </MediaElement> 

                  <MediaAnnotation>

                    <Description>[Annotation goes here]</Description>                              

                    <StartTimecode>[Start timecode goes here, for example, 10:00:00:00]</StartTimecode>               

                    <EndTimecode>[Start timecode goes here, for example, 10:00:00:00]</EndTimecode>

                  </MediaAnnotation>  

              </MediaObject>

          </ImagenRecord>
      </Records>

       

      Postman example