Edit Video

This API can be used to upload media content as a separate step after the video creation API on Indee. The typical workflow would be to create the video on Indee, obtain the indee video key and use the video key to upload additional media such as video, audio and subtitles. It can also be used to edit the video details.

There are two upload methods: Indee Downloaded (ID) media, where you provide a URL and Indee downloads the media, and Customer Uploaded (CU) media, where you're given a URL to upload media directly.

To learn more about the upload methods, see Understanding Media Upload Approaches.

Endpoint

    PUT api/v1/admin/projects/<project_key>/videos/<video_key>

Headers

The JWT Access token should be passed in the authorization header for all APIs.

Header	Value
Authorization	JWT token.

Indee Downloaded (ID) Media

Use the request below when sending Indee the required media, such as video, audio, and image files, using the Indee Downloaded (ID) media method.

Request Body

{
  "name": "Video-1",
  "ext_video_id": "596afghhhxx",
  "project_key": "prj-01hpr6t70xedtepht8b196krsy",
  "description": "some text",
  "video": {
    "upload_type": "ID",
    "url": "https://static.vecteezy.com/system/resources/previews/012/079/660/non_2x.mp4",
    "poster": {
      "upload_type": "ID",
      "url": "https://static.vecteezy.com/system/resources/previews/012/079/660/non_2x/technology-background-modern-abstract-luxury-geometric-shape-premium-wallpaper-for-template-backdrop-brochure-poster-website-or-banner-vector.jpg"
    },
    "audio_tracks": [
      {
        "upload_type": "ID",
        "track_name": "add custom audio",
        "default": true,
        "url": "https://static.vecteezy.com/system/resources/previews/012/079/660/non_2x/technology-background-modern-abstract-luxury-geometric-shape-premium.mp4"
      }
    ],
    "subtitles": [
      {
        "upload_type": "ID",
        "language": "german",
        "default": true,
        "url": "https://static.vecteezy.com/system/resources/previews/012/079/660/non_2x/technology-background-modern-abstract-luxury-geometric-shape-premium.ext"
      }
    ]
  }
}

Name	Type	Description	Optional/Required
`name`	String	The name of the video.	Required
`ext_video_id`	String	A customer provided unique ID for the video.	Required
`project_key`	String	The project key to which the video will be added.	Required
`description`	String	The description of the video.	Optional
`poster`	Dict	A URL and other parameters to add customer’s asset for the video poster.	Optional
`url` (poster)	String	The URL of the media that is to be uploaded.	Optional
`video`	Dict	Contains additional params depending on the selected upload type.	Optional
`upload_type`	String	Defines the type of upload selected for the video such as Indee Download (ID) or Customer Download (CU). In this case it is `ID`	Optional
`url`	String	The URL of the media that is to be uploaded.	Optional
`audio_tracks`	Array	A URL and other parameters to add customer’s asset for the video's audio tracks.	Optional
`upload_type` (audio tracks)	String	Defines the type of upload selected for the video such as Indee Download (ID) or Customer Download (CU). In this case it is `ID`	Optional
`track_name`	String	Name of the audio track.	Optional
`default` (audio tracks)	Boolean	Specifies if the particular track should be set as the default track during playback. If more than one track is set as default, an error code of A4124 will be reported.	Optional
`url` (audio tracks)	String	The URL of the media that is to be uploaded.	Optional
`subtitles`	Array	A URL and other parameters to add customer’s asset for the video's subtitles.	Optional
`upload_type` (subtitles)	String	Defines the type of upload selected for the video such as Indee Download (ID) or Customer Download (CU). In this case it is `ID`	Optional
`language`	String	Language of the subtitle.	Optional
`default` (subtitles)	Boolean	Specifies if the subtitle should be set as the default subtitle during playback. If more than one subtitle is set as default, an error code of A4114 will be reported.	Optional
`url` (subtitles)	String	The URL of the media that is to be uploaded.	Optional

Note

Only users who are Owner of the enterprise, Global Admins, admins or uploaders to that project can call this API. Other users will be denied access.

Response Body

{
  "status_code": "A3100",
  "status_message": "Request for video creation submitted",
  "key": "vid-01hpr7958wq1v97r58n8m0jrfd",
  "name": "Video-1",
  "ext_video_id": "596afghhhxx",
  "project_key": "prj-01hpr6t70xedtepht8b196krsy",
  "poster": {
    "status_code": "A3131",
    "status_message": "Request for adding video poster submitted"
  },
  "subtitles": [
    {
      "status_code": "A3111",
      "status_message": "Request for adding subtitle submitted",
      "language": "german",
      "upload_type": "ID"
    }
  ],
  "audio_tracks": [
    {
      "status_code": "A3121",
      "status_message": "Request for adding audio track submitted",
      "track_name": "add custom audio",
      "upload_type": "ID"
    }
  ]
}

Name	Type	Description
`status_code`	String	Indee provided status code.
`status_message`	String	The message associated with the status code.
`key`	String	Key of the already uploaded video entity.
`name`	String	The name of the video.
`ext_video_id`	String	A customer provided unique ID for the video
`description`	String	A video description
`project_key`	String	The project key to which the video will be added
`poster`	Array	An array containing details of poster uploaded for the video.
`subtitles`	Array	An array containing details of subtitles created for the video.
`language`	String	Language of the subtitle.
`audio_tracks`	Array	An array containing details of audio-tracks created for the video.

Customer Downloaded (CU) Media

Use the request below when sending Indee the required media, such as video, audio, and image files, using the Customer Downloaded (CU) media method.

Request Body

 {
  "name": "Video-1",
  "ext_video_id": "596afghhhxx",
  "project_key": "prj-01hpr6t70xedtepht8b196krsy",
  "description": "some text",
  "video": {
    "upload_type": "CU",
    "filename": "BBB_1min_1aud.mp4",
    "filesize": 14154990,
    "file_contents_hash": "f8bd3ade14274cb03d94e2f7f22ae316"
  },
  "poster": {
    "upload_type": "CU",
    "filename": "bunjee_1.jpg",
    "filesize": 320252,
    "file_contents_hash": "6ee180688042be2022a38c7e2be04053"
  },
  "audio_tracks": [
    {
      "upload_type": "CU",
      "track_name": "1minaudio",
      "default": false,
      "filename": "1minaudio.mp4",
      "filesize": 962300,
      "file_contents_hash": "c6ea9cff745d8788b0919d2f94231c8b"
    }
  ],
  "subtitles": [
    {
      "language": "german",
      "upload_type": "CU",
      "filename": "german",
      "filesize": 1825,
      "file_contents_hash": "eb7ab67466a8f376bf18e4245b586605",
      "default": false
    }
  ]
}

Name	Type	Description	Optional/Required
`name`	String	The name of the video.	Required
`ext_video_id`	String	A customer provided unique ID for the video.	Required
`project_key`	String	The project key to which the video will be added.	Required
`description`	String	The description of the video.	Optional
`video`	Dict	Contains additional params depending on the selected upload type.	Optional
`upload_type`	String	Defines the type of upload selected for the video such as Indee Download (ID) or Customer Download (CU). In this case, it is `CU`	Optional
`file_name`	String	Name of the file.	Optional
`file_size`	String	Size of the file.	Optional
`file_contents_hash`	String	The contents of the file are hashed using MD5 and provided to ensure that the server can validate a uncorrupted upload of the file.	Optional
`poster`	Dict	A URL and other parameters to add customer’s asset for the video poster.	Optional
`upload_type`	String	Defines the type of upload selected for the video such as Indee Download (ID) or Customer Download (CU). In this case, it is `CU`	Optional
`audio_tracks`	Array	A URL and other parameters to add customer’s asset for the video's audio tracks.	Optional
`track_name`	String	Name of the audio track.	Optional
`default` (audio tracks)	Boolean	Specifies if the particular track should be set as the default track during playback. If more than one track is set as default, an error code of A4124 will be reported.	Optional
`subtitles`	Array	A URL and other parameters to add customer’s asset for the video's subtitles.	Optional
`language`	String	Language of the subtitle.	Optional
`default` (subtitles)	Boolean	Specifies if the subtitle should be set as the default subtitle during playback. If more than one subtitle is set as default, an error code of A4114 will be reported.	Optional
`file_contents_hash`	Array	The contents of the file are hashed using MD5 and provided to ensure that the server can validate a uncorrupted upload of the file.	Optional

Response Body

{
  "status_code": "A3100",
  "status_message": "Request for video creation submitted",
  "key": "vid-01hpr7958wq1v97r58n8m0jrfd",
  "name": "Video-1",
  "ext_video_id": "596afghhhxx",
  "project_key": "prj-01hpr6t70xedtepht8b196krsy",
  "poster": {
    "status_code": "A3131",
    "status_message": "Request for adding video poster submitted",
    "url": "https://indee-qa2-media-20220224063945059100000003.s3.amazonaws.com/3/video/62571_originalsize_videoposter.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAVH3HWP7HXJF7MKOS%2F20240729%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240729T130722Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEUaCXVzLWVhc3QtMSJHMEUCIQCXKYhvtzxMiht3LK6t9X1z53xkCHlrkliK8FlOPOctUAIgNttkSpq4v54SDNrEn14ZWnqiQ0A3bMKfoCd7TNPAj00q7QMILhACGgwzNjA0NTc4NjMxMTkiDAyGPkQfkgg80GA5QyrKA003TiXHBFks61rhqCDbAIfZ0MFGd6CSLJ4ayPNolKQP29ajEZlnVBJq3rfuxf8QJV%2B3b5ENYj07wtn1StomP2I5bngey4ksDaXtjHrLiN62vuXBHj7XbRDxkarlXDX%2BnANRsv61RpTB%2BrqJVI%2FKXOIlOcfjTEN9V%2FChbdhstD7ql%2B8cL6asEk9pYWhb8mc7tQkVkWkWCsiqqoPH6biKCyjhVcnxk3ZbO0vdzc%2Fxr6W5nVBbTddbsksjN9zzmkvH4GHCKaUOwhPyMeRvdU0cwHunq6AK00Tv7lPDKPgRuM3rxsjkw47I%2ByJ90%2BX1Vnf6Y59%2FaYO3I3zIB5PeeJBaKk1JJcOUrLd7vVYBMX6aYwNf2TzNje0h5JRlAgxdd0TVJIDCnaYgxI9i8ybKT0SbD3q53j9Q0t0Mr2gpolf9J1IjcyV7ccdi1zfq2N7aqZWA5rcc3YqLgs6fTGN8D9Dgf4CXHmbBaYzNdFe2Im8N5K%2BkQtJTG9Z0dEGRWhC2LWq9bLtD78Pq3R9IEsIekfdmtRqBaF0g1zo8LeJ0OglZFUSQwTxfV5TOkMm2XFgPvP5A9idGazvPp7DZeJ6ysGIHEFp4skoMMgemJeVFMN%2BlnrUGOqUB1oqwyRt1VNOSVh5pmpMSxffB4HYUqDyXBnvWxU84MdcDUr%2Bf2zJaXkGTHFUTriMhR2P%2BIKxyB%2FgWSXI4vnIijGw6BoDkqGedLslBLvEaqiPrMHTWTDck6%2BtunDd6K7wHw60e9IRhnq3HbkVW5XBuy8qwhraVLaEkuhBNhp%2FRamqBGCFSyZNyGPgy0yj856B5FpWG8B96lUPSvP5PU472yyCF56sF&X-Amz-Signature=c5d3dd7c7862b5369663821c84ff2fd690f9f06f1d1d1fadf3148e9796b4a340"
  },
  "subtitles": [
    {
      "status_code": "A3111",
      "status_message": "Request for adding subtitle submitted",
      "language": "german",
      "upload_type": "CU",
      "url": "https://indee-qa2-media-20220224063945059100000003.s3.amazonaws.com/3/video/3_62571_7454246482_1722258442347583.vtt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAVH3HWP7HXJF7MKOS%2F20240729%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240729T130722Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEUaCXVzLWVhc3QtMSJHMEUCIQCXKYhvtzxMiht3LK6t9X1z53xkCHlrkliK8FlOPOctUAIgNttkSpq4v54SDNrEn14ZWnqiQ0A3bMKfoCd7TNPAj00q7QMILhACGgwzNjA0NTc4NjMxMTkiDAyGPkQfkgg80GA5QyrKA003TiXHBFks61rhqCDbAIfZ0MFGd6CSLJ4ayPNolKQP29ajEZlnVBJq3rfuxf8QJV%2B3b5ENYj07wtn1StomP2I5bngey4ksDaXtjHrLiN62vuXBHj7XbRDxkarlXDX%2BnANRsv61RpTB%2BrqJVI%2FKXOIlOcfjTEN9V%2FChbdhstD7ql%2B8cL6asEk9pYWhb8mc7tQkVkWkWCsiqqoPH6biKCyjhVcnxk3ZbO0vdzc%2Fxr6W5nVBbTddbsksjN9zzmkvH4GHCKaUOwhPyMeRvdU0cwHunq6AK00Tv7lPDKPgRuM3rxsjkw47I%2ByJ90%2BX1Vnf6Y59%2FaYO3I3zIB5PeeJBaKk1JJcOUrLd7vVYBMX6aYwNf2TzNje0h5JRlAgxdd0TVJIDCnaYgxI9i8ybKT0SbD3q53j9Q0t0Mr2gpolf9J1IjcyV7ccdi1zfq2N7aqZWA5rcc3YqLgs6fTGN8D9Dgf4CXHmbBaYzNdFe2Im8N5K%2BkQtJTG9Z0dEGRWhC2LWq9bLtD78Pq3R9IEsIekfdmtRqBaF0g1zo8LeJ0OglZFUSQwTxfV5TOkMm2XFgPvP5A9idGazvPp7DZeJ6ysGIHEFp4skoMMgemJeVFMN%2BlnrUGOqUB1oqwyRt1VNOSVh5pmpMSxffB4HYUqDyXBnvWxU84MdcDUr%2Bf2zJaXkGTHFUTriMhR2P%2BIKxyB%2FgWSXI4vnIijGw6BoDkqGedLslBLvEaqiPrMHTWTDck6%2BtunDd6K7wHw60e9IRhnq3HbkVW5XBuy8qwhraVLaEkuhBNhp%2FRamqBGCFSyZNyGPgy0yj856B5FpWG8B96lUPSvP5PU472yyCF56sF&X-Amz-Signature=b3527d2cb79898ce33927e7ebb1cdf3b96f0a32dd01f05fbbddb0b6c0c60503b"
    }
  ],
  "audio_tracks": [
    {
      "status_code": "A3121",
      "status_message": "Request for adding audio track"
   }
  ]
  }

Error Codes

Indee provides a comprehensive list of Error Codes. To know more, see Common Error and Success Codes.