Skip to main content

Create Encoding Job

Using create encoding job API

Encoding API converts source video into compressed version in multiple resolutions up to 1080p resolutions.

curl --L --X POST 'https://api.videosdk.live/v1/encoder/jobs' \
--header 'Authorization: `your token goes here`' \
--header 'Content-Type: application/json' \
--data-raw '
{
"videoId": "6053115ebba24b4d700c8c49",
"presets": [
{
"resolutions": ["240", "360", "480"],
"format": "hls"
}, {
"resolutions": ["360"],
"format": "mp4"
}
],
"thumbnails": [
{
"timestamp": "00:00:03",
"resolutions": ["360"],
"formats": ["jpg", "webp"],
"filters": ["none", "blur"]
}
],
"webhookUrl":"https://<your-website-address>/<path>"
}'

Request

  • __requestrequiredobject

      Properties
    • videoIdrequiredstring

    • presetsrequiredArray<object>

    • resolutionsrequiredArray<string>

      Possible values are 240, 360, 720, 1080 and 4k
    • formatrequiredstring

      Possible values are hls and mp4
  • thumbnailsoptionalArray<object>

    • timestamprequired if thumbnailsstring

      Timestamp format would be 'HH:MM:SS' i.e. '00:00:03'
    • resolutionsrequired if thumbnailsArray<string>

      Possible values are '240', '360', '720', '1080' and '4K'
    • formatsrequired if thumbnailsArray<string>

      Possible values are 'jpg' and 'webp'
    • filtersoptionalArray<string>

      Possible values are 'none' and 'blue'
  • webhookUrlrequiredstring

  • userDatarequiredobject

Response

  • __responseobject

      Response
    • statusstring

    • videoIdstring

    • presetsArray<object>

      • resolutionsArray<string>

        Possible values are 240, 360, 720, 1080 and 4k
      • formatstring

        Possible values are hls and mp4
    • thumbnailsArray<object>

      • timestampstring

      • resolutionsArray<string>

      • formatsArray<string>

      • filtersArray<string>

    • webhookUrlstring