- Documentation
- API Reference
- Projects
- importer.vidinfra.com
- 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
- Organization
- Organization's invitations
- Audits
- Members
- API Keys
- Folders
- Videos
- Video Metas
- Video Captions
- Video Chapter
- Uploads
- Tags
- Players
- Webhook Endpoints
- Advertisements
- Webhook Event Logs
- 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
- Stream Metas
- Usages
- Encoding profile
- Project Matrics
- Access Control
- Analytics
- Project Get geo-distribution
- project views
- Project avg video watch
- Project Total Watch
- Project Avg Watch per Unique user
- Project All Player Errors
- Project Popularity Analysis
- Project 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
- Upload Tokens
- subscribe
- Transaction
- Invoice
- vimeo video importer
- test
- transcoding service
- transcoding service v2
- Welcome to vidinfraGET
- health checkGET
- Regions ListGET
- keyPOST
- Untitled EndpointGET
create jobs
Developing
POST
/jobs
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Body Params application/json
video_id
stringÂ
required
upscale
booleanÂ
required
webhook_config
objectÂ
required
url
stringÂ
required
headers
objectÂ
required
source
objectÂ
required
type
stringÂ
required
region
stringÂ
required
key
stringÂ
required
secret
stringÂ
required
bucket
stringÂ
required
path
stringÂ
required
endpoint
stringÂ
required
is_passive
booleanÂ
required
use_tls
booleanÂ
required
format
array [object {45}]Â
required
output
stringÂ
required
destination
objectÂ
required
stream
array [object {7}]Â
required
playlist_name
stringÂ
required
segment_duration
stringÂ
required
image_format
stringÂ
optional
time
stringÂ
optional
height
integerÂ
required
width
integerÂ
required
video_codec
stringÂ
required
quality
integerÂ
required
optimize_bitrate
integerÂ
required
bitrate
stringÂ
optional
audio_mute
booleanÂ
required
video_codec_parameters
objectÂ
optional
adjust_crf
stringÂ
optional
min_crf
stringÂ
optional
max_crf
stringÂ
optional
framerate
integerÂ
required
keyframe
integerÂ
optional
aspect_ratio
stringÂ
optional
resize_mode
stringÂ
optional
rotate
stringÂ
optional
start_time
stringÂ
optional
duration
stringÂ
optional
logo
objectÂ
optional
hdr_to_sdr
integerÂ
optional
audio_bitrate
stringÂ
optional
audio_sample_rate
stringÂ
optional
audio_channels_number
stringÂ
optional
color_space
stringÂ
optional
color_range
stringÂ
optional
color_trc
stringÂ
optional
color_primaries
stringÂ
optional
separate_audio
booleanÂ
required
subtitles
objectÂ
required
allow_soft_fail
integerÂ
required
encryption
objectÂ
optional
cenc_drm
objectÂ
required
deinterlace
booleanÂ
optional
transcript
integerÂ
optional
json
integerÂ
optional
srt
integerÂ
optional
vtt
integerÂ
optional
mode
stringÂ
optional
Example
{
"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
}
]
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:8080/v1/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
}
]
}'
Responses
🟢200Success
application/json
Body
object {0}
Example
{"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}
🟢200OK