View Source

List information about all Jobs

GET /jobs

Authorization Header

Bearer token: OAuth 2.0 API access token.

Parameters

start: offset for paging (optional)
limit: number of profile items per page (optional)
sort: The key by which to sort the result, e.g. "sort=created_at" to sort by creation date.
direction: Sort records in ascending ("1") or descending ("-1") order. Default value: "1".
format: json or xml. This will override the Request Accept header.
human: true or false. If true, will return the response in a structured, more human-readable form. Useful when calling the API through curl or from the browser.
bin_data: true or false. If set to true, the response will include also binary data (like the input file thumbnail) as data-uri. Default value: false.
user_data: Filter result to return only Jobs matching the given user_data
inprogress: true or false. If true, filters the result to contain only the jobs that are currently in progress or have just completed within the past 15 minutes.
autograph: true or false. If set, filters the result to include only jobs that have the autograph option enabled ("true") or that have it disabled ("false").
pipeline.id: Filters result to include only Jobs matching the given pipeline id.
input.file.name: Filters the result to contain only Jobs with an input file name matching the given value. This filter performs a partial and case insensitive match, so if the input file name contains the provided string it is a match.
expand_all: true or false. Recursively look up referenced objects (e.g. file id) and embed the respective json as a nested object directly into the response.
expand: Comma separated referenced objects (e.g. file,preset). Look up specified ids and embed the respective json as a nested object directly into the response.
show_null: true or false. If set to "true", the response will contain also keys that are not set to a value.

Example

curl -H "Authorization: Bearer um9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j" "https://api.xvid.com/v1/jobs/?human=true&show_null=true&limit=2"
{
	jobs: [{
		pipeline: {
			id: "552b87a814eab3a29d1b3d90",
			href: "https://api.xvid.com/v1/pipelines/552b87a814eab3a29d1b3d90"
		},
		application: {
			id: "552cae3514ea10cb4d3ac69e",
			href: "https://api.xvid.com/v1/applications/552cae3514ea10cb4d3ac69e"
		},
		user_data: null,
		input: {
			input_name: "uploads/vnaqaHDKsCfX6X1UNN1iU97aSpkspyPP/movie.mp4",
			force_container: null,
			force_aspect_ratio: null,
			force_framerate: null,
			force_interlaced: null,
			file: {
				id: "559cbbe7a636e56d8ae111f0",
				href: "https://api.xvid.com/v1/files/559cbbe7a636e56d8ae111f0"
			}
		},
		autograph: null,
		output_prefix: "559cbbec14ea67a7cad6c7d8/",
		outputs: [{
			preset: {
				id: "5260e39d84aea12008b69bc1",
				href: "https://api.xvid.com/v1/presets/5260e39d84aea12008b69bc1"
			},
			file: {
				id: "559cbbeca636e56d8ae111f4",
				href: "https://api.xvid.com/v1/files/559cbbeca636e56d8ae111f4"
			},
			output_name: "MyTest",
			percentage_completed: 100,
			thumbnail_zip: {
				file: {
					id: "559cbbeca636e56d8ae111f2",
					href: "https://api.xvid.com/v1/files/559cbbeca636e56d8ae111f2"
				}
			},
			thumbnails: [{
				thumbnail_names: "MyTest_{resolution}",
				thumbnail_preset: "thumbnails_small",
				file: {
					id: "559cbbeca636e56d8ae111f3",
					href: "https://api.xvid.com/v1/files/559cbbeca636e56d8ae111f3"
				}
			}],
            logos: [{
              "logo_image": "https://s3-us-east-1.amazonaws.com/my_logo_pngs/logo30.png",
              "logo_preset": "logo_30_bottom_right"
            }],
			settings: null
		}],
		status: "SUCCESS",
		percentage_completed: 100,
		error_msg: null,
		error_code: null,
		finished_at: 1436335151874,
		version: 1,
		user: {
			id: "552b874d14eab3a29d1b3d8d",
			href: "https://api.xvid.com/v1/users/552b874d14eab3a29d1b3d8d"
		},
		created_at: 1436335084087,
		updated_at: 1436335083585,
		id: "559cbbec14ea67a7cad6c7d8",
		href: "https://api.xvid.com/v1/jobs/559cbbec14ea67a7cad6c7d8"
	},
	{
		pipeline: {
			id: "552b87a814eab3a29d1b3d90",
			href: "https://api.xvid.com/v1/pipelines/552b87a814eab3a29d1b3d90"
		},
		application: {
			id: "552cae3514ea10cb4d3ac69e",
			href: "https://api.xvid.com/v1/applications/552cae3514ea10cb4d3ac69e"
		},
		user_data: null,
		input: {
			input_name: "uploads/4zQDEePj3OvOL1ntpDUwZA-TCulZ4Qm0/movie.mp4",
			force_container: null,
			force_aspect_ratio: null,
			force_framerate: null,
			force_interlaced: null,
			file: {
				id: "559cb9daa636e56d8ae111e8",
				href: "https://api.xvid.com/v1/files/559cb9daa636e56d8ae111e8"
			}
		},
		autograph: null,
		output_prefix: "559cb9df14ea67a7cad6c7ce/",
		playlists: null,
		outputs: [{
			preset: {
				id: "553e32a814ea6b068bfa732e",
				href: "https://api.xvid.com/v1/presets/553e32a814ea6b068bfa732e"
			},
			file: {
				id: "559cb9dfa636e56d8ae111ea",
				href: "https://api.xvid.com/v1/files/559cb9dfa636e56d8ae111ea"
			},
			output_name: "Test2",
			percentage_completed: 100,
			thumbnail_zip: null,
			thumbnails: null,
			logos: null,
			settings: null
		}],
		status: "SUCCESS",
		percentage_completed: 100,
		error_msg: null,
		error_code: null,
		finished_at: 1436334743244,
		version: 1,
		user: {
			id: "552b874d14eab3a29d1b3d8d",
			href: "https://api.xvid.com/v1/users/552b874d14eab3a29d1b3d8d"
		},
		created_at: 1436334559806,
		updated_at: 1436334559495,
		id: "559cb9df14ea67a7cad6c7ce",
		href: "https://api.xvid.com/v1/jobs/559cb9df14ea67a7cad6c7ce"
	}],
	total: 124,
	start: 0,
	limit: 2,
	first: {
		href: "https://api.xvid.com/api/v1/jobs/?start=0&limit=2&direction=-1&expand_all=false&sort=created_at&_=1436332921799&show_null=true"
	},
	last: {
		href: "https://api.xvid.com/api/v1/jobs/?start=122&limit=2&direction=-1&expand_all=false&sort=created_at&_=1436332921799&show_null=true"
	},
	next: {
		href: "https://api.xvid.com/api/v1/jobs/?start=2&limit=2&direction=-1&expand_all=false&sort=created_at&_=1436332921799&show_null=true"
	},
	prev: {
		href: "https://api.xvid.com/api/v1/jobs/?start=0&limit=2&direction=-1&expand_all=false&sort=created_at&_=1436332921799&show_null=true"
	}
}