vidinfra
  1. transcoding service v2
vidinfra
  • Documentation
    • Guides
      • Welcome
      • Getting Started
        • What is Vidinfra?
        • Quick Start Guide
        • Publish First Video
        • FAQs
      • Upload & Import Videos
        • Upload from Device
        • Import from Vimeo
        • Import from YouTube
        • Import from Zoom
      • DRM
        • Widevine DRM
        • FairPlay DRM
      • Accounts
        • Accounts
      • Organization Settings
        • User Management
        • Billing
        • Settings
  • API Reference
    • Admin
      • User
        • Create User
        • Find users
    • Auth
      • User Registration
      • User Login
      • Verify-email
      • Forgot Password
      • Forgot Password Verify OTP
      • Forgot Password Set
      • Resend OTP
      • Logout
      • Set Password
      • Check Account exists
      • Update Password
      • Google Oauth Redirect
      • Google Oauth Callback
      • api-access-check
      • New Auth token using Refresh token
      • Github Oauth Redirect
      • Google Oauth Callback Copy
      • Get User Sessions
      • Delete User Sessions
    • User
      • Profiles
      • Profile Updates
      • DEL User
      • Profile Avatar update
      • Permission Details
    • Libraries
      • Get Library List
      • Get Library Details
      • Create New Library
      • Destory Library
      • Update Library
      • Update Logo
      • Get Library Settings
      • Upsert Library Settings
    • Organization
      • Delete a Organization
      • List organizations
      • Create an organization
      • Get an organization
      • Update an organization
      • Switch an organization
    • Organization's invitations
      • Sent invitation list
      • Send invitation
      • Show Token
      • Accept Invitation
      • Reject Invitation
    • Audits
      • Audits
    • Members
      • Members
      • test permission
    • API Keys
      • Get All API keys
      • Get API Key
      • Create API Keys
      • Destory API Keys
      • api key middleware (test)
    • Folders
      • Get All Folders
      • Create Folder
      • Get Folder by ID
      • Update Folder
      • Move Folder
      • Bulk Move Folders (empty)
      • Delete Folder
      • Get Folder Tree
    • Videos
      • Get All video of a library
      • Get a Video
      • Get Video using Custom field
      • create video
      • Upload thumbnail
      • Update video
      • Destroy video
      • Search Video
      • batch video Assign to collecition
      • Mark Thumbnail As Default
      • Get Video Timelines
    • Video Metas
      • Create or Update Video Meta Data
      • Get All Meta Data of a Video
    • Video Captions
      • create video caption
      • Delete a video Caption
      • Get video caption
    • Video Chapter
      • create video chapters
    • Uploads
    • Tags
      • Get all tags upder a project
      • Create Tag
      • Delete tag
    • Players
      • Get all Players
      • Create Player
      • Get Specific player
      • update player
      • Delete Player
      • Player Mark as default
    • Webhook Endpoints
      • Get webhook
      • Create web hook
      • GET Webhook by ID
      • Update webhook
      • Delete web hook
    • Advertisements
      • Get all ads
      • Create ads
      • Get single advertisement
      • Update ads
      • Delete ads
    • Migrate
      • welcome
      • Debug
      • test
    • Webhook Event Logs
      • Get webhook event logs
      • Resend Webhook event by Id
      • Resend All Webhook Event
    • Analytics Direct Api
      • geo-distribution
      • Project Views
      • avg video watch
      • Total watch Time
      • Project Avg Watch per Unique user
      • Total Player Error
      • project popularity-analysis
      • Project Collection Insights
      • Collection Views
      • Collection avg Watch time
      • Collection Avg Watch per unique user
      • Collection Geo Distribution
      • Get all Users
      • User media views
      • User Avg video watch
      • user Player log
      • user sessions
      • Get all Video
      • video Player error
      • Video View
      • video Geo Distribution
      • video Avg watch
      • copy
    • Streams
      • Create livestream
      • Get all stream
      • Get a livestream
      • update status of livestream
      • delete a stream
      • get livestream historys
    • Stream Metas
    • Usages
      • Bandwidth Usage
      • Storage Usage
      • Get Over Usage
    • Encoding profile
      • Get all profiles
      • Create profile
      • Get A profile
      • Update a encoding profile
      • Delete a encoding profile
      • Make a profile default
    • Library Matrics
      • Admin
      • Get Matrics
      • project Usages
    • Access Control
      • Put Access Control
      • Get access Control
    • Analytics
      • Library Get geo-distribution
      • Library views
      • Library avg video watch
      • Project Total Watch
      • Library Avg Watch per Unique user
      • Library All Player Errors
      • Library Popularity Analysis
      • Library Collections insights
      • Collection Geo Distribution
      • Collection avg watch time
      • Collection avg watch per unique User
      • Collection Player error
      • Video Geo Distribution
      • Video views
      • Video Avg Watch
      • Video Player Log
      • User
      • User Avg Video Watch
      • User Total Watch
      • User player error log
    • Plan
      • public plans
      • current plan
      • Account Plans
      • Get plan by ID
      • Admin Get Plans
      • Admin Create plan
      • Admin Get Plan by ID
      • Admin Update Plan by ID
      • Admin Delete plan By ID
      • Admin Get Plan Metrices
      • Admin Get Plan Metrices By Type
      • Admin Create Plan Matrices By Type
      • Admin Update Plan Metrices By ID
    • Upload Tokens
      • Obtain credentials before upload
    • subscribe
      • stripe redirect subscription
        • create checkout session
        • over usage payment
      • current subscription
      • discribe a plan by planCode
      • subscribe
      • cancel subscription
      • over usage payment
      • Stripe over usage autopay payment (test)
    • Transaction
      • Get All Transaction
    • Invoice
      • Get All Invoices
      • Get Invoice by ID
    • vimeo video importer
      • vimeo job list
      • Vimeo videos by migration id
      • Vimeo Set video importer
      • Vimeo sync import
      • Vimeo import videos
      • Get pull videos
      • pull video from url
    • test
      • Welcome to vidinfra Copy
      • metrics
    • transcoding service
      • get all jobs
      • get a job
      • create jobs
      • Update a job
      • Delete a job
      • create job v2
    • transcoding service v2
      • create jobs
        POST
      • get all jobs
        GET
      • get a job
        GET
      • Update a job
        PUT
      • Delete a job
        DELETE
    • User
    • Welcome to vidinfra
      GET
    • health check
      GET
    • Regions List
      GET
    • key
      POST
    • Untitled Endpoint
      GET
  • CDN
    • Distributions
      • CDN Distribution API – Create Distribution
      • Ge Distribution List
      • Update A Distribution
      • Delete Distribution
      • Get A Distribution Details
    • SSL Certificate Manage
      • Let's Encrypt
      • Get Certificate
      • Delete Certificate
      • Get List Certificates
      • Create New SSL
    • Origins/Upstreams Manage
    • Purge
    • Cache Rules
    • Access Rules
    • Analytics
      • analytics
  • Billing
    • Plans
    • Billable Metrics
    • Pricing Rules
    • Usage Metrics
    • Charge Models
    • Pricing Tiers
    • Wallet
    • Invoices
    • Audit Logs
    • Add-Ons
  1. transcoding service v2

create jobs

Developing
POST
/jobs
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vidinfra.com/jobs' \
--header 'Content-Type: application/json' \
--data-raw '{
  "video_id": "abc123",
  "upscale": true,
  "webhook_config": {
    "url": "https://custom-client-webhook.com/notify",
    "headers": {
      "authorization": "Bearer token",
      "x-api-key": "api_key"
    }
  },
  "source": {
    "region": "us-west-1",
    "type": "s3",
    "is_passive": true,
    "key": "source_key",
    "secret": "source_secret",
    "bucket": "source_secret",
    "endpoint": "https://source-url.com",
    "path": "/video.mp4",
    "use_tls": true
  },
  "format": [
    {
      "output": "mp4",
      "video_codec": "libx264",
      "height": 1440,
      "quality": 20,
      "optimize_bitrate": 1,
      "bitrate": "1000",
      "audio_mute": true,
      "video_codec_parameters": {
        "min_rate": "100",
        "max_rate": "1000",
        "bufsize": "1",
        "vprofile": "mediam",
        "level": "31",
        "coder": "0",
        "directpred": "2",
        "me_method": "hex",
        "subq": "2`2`",
        "trellis": "11313",
        "refs": "11",
        "cmp": "11",
        "me_range": "1",
        "sc_threshhold": "11",
        "l_qfactor": "1",
        "b_strategy": "1",
        "qcomp": "11",
        "qmin": "11",
        "qdiff": "11",
        "sws_flags": "11",
        "preset": "media",
        "flags": "101031",
        "rc_lookahead": "1100"
      },
      "adjust_crf": "1",
      "min_crf": "1",
      "max_crf": "1",
      "framerate": 30,
      "keyframe": 90,
      "aspect_ratio": "16:9",
      "resize_mode": "crop",
      "rotate": "10",
      "start_time": "12",
      "duration": "10",
      "logo": {
        "source": "https://wwww.sowhrwlrl11.com",
        "x": "10",
        "y": "10"
      },
      "hdr_to_sdr": 1,
      "audio_bitrate": "64",
      "audio_sample_rate": "44100",
      "audio_channels_number": "2",
      "color_space": "1",
      "color_range": "1",
      "color_trc": "1",
      "color_primaries": "1"
    },
    {
      "output": "advanced_hls",
      "separate_audio": true,
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      },
      "stream": [
        {
          "video_codec": "libx264",
          "height": 2160,
          "bitrate": 12000,
          "framerate": "30",
          "keyframe": "90"
        },
        {
          "video_codec": "libx264",
          "height": 1440,
          "bitrate": 8500,
          "framerate": "30",
          "keyframe": "90"
        }
      ],
      "audio_mute": true,
      "subtitles": {
        "sources": [
          {
            "source": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/sub.txt",
            "language": "eng"
          }
        ],
        "copy": 1
      },
      // "cenc_drm": {
      //   "key": "DRM encryption key",
      //   "key_id": "DRM encryption key id",
      //   "pssh": "DRM encryption PSSH",
      //   "la_url": "License server URL"
      // },
      "allow_soft_fail": 1,
      "optimize_bitrate": 0,
      "playlist_name": "playlist.m3u8",
      "segment_duration": "6",
      "encryption": {
        "key": "key",
        "iv": "iv",
        "key_url": "https://ahmedraka.me"
      }
    },
    {
      "output": "advanced_mp4",
      "separate_audio": true,
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      },
      "stream": [
        {
          "video_codec": "libx264",
          "height": 2160,
          "bitrate": 12000,
          "framerate": "30",
          "keyframe": "90"
        },
        {
          "video_codec": "libx264",
          "height": 1440,
          "bitrate": 8500,
          "framerate": "30",
          "keyframe": "90"
        }
      ],
      "audio_mute": true,
      "subtitles": {
        "sources": [
          {
            "source": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/sub.txt",
            "language": "eng"
          }
        ],
        "copy": 1
      },
      "cenc_drm": {
        "key": "DRM encryption key",
        "key_id": "DRM encryption key id",
        "pssh": "DRM encryption PSSH",
        "la_url": "License server URL"
      },
      "allow_soft_fail": 1,
      "optimize_bitrate": 0,
      "playlist_name": "playlist.m3u8",
      "segment_duration": "6",
      // "encryption": {
      //   "key": "key",
      //   "iv": "iv",
      //   "key_url": "https://ahmedraka.me"
      // }
    },
    {
      "output": "thumbnail",
      "image_format": "jpg",
      "time": "0.1",
      "height": 270,
      "width": 270,
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      },
      "allow_soft_fail": 1
    },
    {
      "output": "gif",
      "height": 180,
      "width": 320,
      "framerate": 15,
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      }
    },
    {
      "output": "mp4",
      "video_codec": "libx264",
      "height": 2160,
      "quality": 20,
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      },
      "audio_mute": true,
      "subtitles": {
        "copy": 1
      },
      "deinterlace": true,
      "allow_soft_fail": 1
    },
    {
      "output": "speech_to_text",
      "transcript": 1,
      "json": 1,
      "srt": 1,
      "vtt": 1,
      "mode": "balanced",
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      }
    },
    {
      "output": "advanced_dash",
      "separate_audio": true,
      "destination": {
        "type": "s3",
        "is_passive": false,
        "key": "destination_key",
        "secret": "destination_secret",
        "bucket": "my_bucket",
        "region": "us-west-1",
        "path": "/path/to/destination",
        "endpoint": "https://destination-url.com/",
        "use_tls": true,
        "permissions": true
      },
      "stream": [
        {
          "video_codec": "libx264",
          "height": 2160,
          "optimize_bitrate": true,
          "deinterlace": true,
          "framerate": "12",
          "keyframe": "90"
        },
        {
          "video_codec": "libx264",
          "height": 1440,
          "optimize_bitrate": true,
          "deinterlace": true,
          "framerate": "12",
          "keyframe": "90"
        }
      ],
      "playlist_name": "playlist.mpd",
      "segment_duration": "6",
      "audio_mute": true,
      "subtitles": {
        "sources": [
          {
            "source": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/sub.txt",
            "language": "eng"
          }
        ],
        "copy": 1
      },
      "cenc_drm": {
        "key": "DRM encryption key",
        "key_id": "DRM encryption key id",
        "pssh": "DRM encryption PSSH",
        "la_url": "License server URL"
      },
      "allow_soft_fail": 1
    }
  ]
}'
Response Response Example
200 - Success - Success
{"message":"Transcoding job created successfully","result":{"video_id":"video123","webhook_config":{"url":"https://example.com/webhook","headers":{"authorization":"Bearer token123"}},"source":{"region":"us-east-1","type":"s3","key":"source_access_key","secret":"source_secret_key","bucket":"source-bucket","endpoint":"https://s3.amazonaws.com","path":"/input/video.mp4"},"format":[{"output":"hls","separate_audio":false,"destination":{"type":"s3","key":"dest_access_key","secret":"dest_secret_key","bucket":"destination-bucket","region":"us-east-1","path":"/output/hls","endpoint":"https://s3.amazonaws.com","permissions":false},"stream":[{"video_codec":"libx264","height":720,"bitrate":2000,"framerate":"30","keyframe":""}],"audio_mute":false,"subtitles":null,"cenc_drm":null,"allow_soft_fail":0,"optimize_bitrate":0,"playlist_name":"master.m3u8","segment_duration":"6","encryption":null,"image_format":"","time":"","height":0,"width":0,"framerate":0,"quality":0,"transcript":0,"json":0,"srt":0,"vtt":0,"mode":"","deinterlace":false},{"output":"thumbnail","separate_audio":false,"destination":{"type":"s3","key":"dest_access_key","secret":"dest_secret_key","bucket":"destination-bucket","region":"us-east-1","path":"/output/thumbnail","endpoint":"https://s3.amazonaws.com","permissions":false},"stream":null,"audio_mute":false,"subtitles":null,"cenc_drm":null,"allow_soft_fail":0,"optimize_bitrate":0,"playlist_name":"","segment_duration":"","encryption":null,"image_format":"jpg","time":"00:00:05","height":360,"width":640,"framerate":0,"quality":0,"transcript":0,"json":0,"srt":0,"vtt":0,"mode":"","deinterlace":false}]},"success":true}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟢200OK
Modified at 2025-06-19 04:59:01
Previous
create job v2
Next
get all jobs
Built with