Create a new Backtrace


POST /backtraces/

Authorization Header

  • Bearer token: OAuth 2.0 API access token. 

Parameters 

  • format : json or xml. This will override Request Accept header.
  • human : true or false. If set to 'true', the response will be in a structured, more human-readable form. This is mainly useful when calling the API through curl or a browser.
  • job_id : The job id of the original video the copy to trace belongs to.
     

Request Body

POST /backtraces/
curl -X POST -H "Authorization: Bearer um9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j" -H "application/json" -d "\
{ \
    'backtrace': { \
                    'pipeline' :{ \
                            'id': '552b87a814eab3a29d1b3d90' \
                    }, \
                    'input' : { \
                            'input_name' :'uploads/QOSifPpTys1wcnEli3aXo50nyj2JROdO/movie.mp4' \
                    } \
    } \
}" "https://api.xvid.com/v1/titles/backtraces/?job_id=56f023dee4b00c798948107a&human=true&show_null=true"

Valid Fields:

  • pipeline_id: References the pipeline on which to perform the Backtrace. This specifies the input locations for the Backtrace's input (input_name will be relative to the input directive configured in the respective pipeline).

  • input:input_name: The URI/Filename of the input video file to backtrace. If given as a relative path, it is treated relative to the base input uri set in the referenced Pipeline.

Get info on a specific Backtrace


GET /backtraces/ID

Authorization Header

  • Bearer token: OAuth 2.0 API access token. 

Parameters: 

  • ID : ID of the backtrace returned by a previous POST call to the backtrace API.
  • format : json or xml. This will override Request Accept header.
  • human : true or false. It causes the response to be in a structured, more human-readible form. This is useful when calling the API through curl or a browser.
  • expand_all: true or false. Recursively look up referenced objects (e.g. user) and embed the respective json as a nested object directly into the response.
  • expand: Comma separated referenced objects (e.g. preset, user). Look up specified ids and embed the respective json as a nested object directly into the response


GET /backtraces/ID
curl -H "Authorization: Bearer um9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j" "https://api.xvid.com/v1/titles/backtraces/54761380e4b0fc918f8b8b13?human=true&show_null=true"
{ 
  backtrace: {
	input: {
		input_name: "uploads/PwM34nMUcvCQ5AyQN7bQvffK6GD_eZyp/movie.mp4"
	},
	pipeline: {
		id: "552b87a814eab3a29d1b3d90",
		href: "https://api.xvid.com/v1/pipelines/552b87a814eab3a29d1b3d90"
	},
	file: {
		id: "559b65d4e13d8265e982cd5a",
		href: "https://api.xvid.com/v1/files/559b65d4e13d8265e982cd5a"
	},
	extracted_data: [{
		autograph_tag: "test_tag",
        access_stats: [{
            ip_address: "5.9.119.0",
            ip_country: "Germany",
            ip_type: "DCH",
            user_agent: "Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.103 Safari/537.36",
            accept_language: "N/A",
            first_accessed_at: 1456099369000,
            percentage_obtained: "100%",
            highest_resolution: "720p",
            streaming_only: "no"
        }]
	}],
    application: {
        id: "54e89692e4b069d88de25f8f"
        href: "https://api.xvid.com/v1/applications/54e89692e4b069d88de25f8f"
    }
	status: "SUCCESS",
    percentage_completed: 100,
    error_msg: null,
    error_code: null,
	finished_at: 1436247563709,
	version: 1,
	user: {
		id: "552b874d14eab3a29d1b3d8d",
		href: "https://api.xvid.com/v1/users/552b874d14eab3a29d1b3d8d"
	},
	created_at: 1436247512758,
	updated_at: 1436247512758,
	id: "559b65d814eabe5486ff6ed5"
  }
}

List all Backtraces


GET /backtraces/

Authorization Header

  • Bearer token: OAuth 2.0 API access token. 

Parameters: 

  • ID : ID of the backtrace returned by a previous POST call to the backtrace API.
  • format : json or xml. This will override Request Accept header.
  • human : true or false. It causes the response to be in a structured, more human-readible form. This is useful when calling the API through curl or a browser.
  • 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".
  • expand_all: true or false. Recursively look up referenced objects (e.g. user) and embed the respective json as a nested object directly into the response.
  • expand: Comma separated referenced objects (e.g. preset, user). Look up specified ids and embed the respective json as a nested object directly into the response


GET /backtraces
curl -H "Authorization: Bearer um9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j" "https://api.xvid.com/v1/titles/backtraces/?human=true&show_null=true" 
{
"backtraces": [
 {
	input: {
		input_name: "uploads/PwM34nMUcvCQ5AyQN7bQvffK6GD_eZyp/movie.mp4"
	},
	pipeline: {
		id: "552b87a814eab3a29d1b3d90",
		href: "https://api.xvid.com/v1/pipelines/552b87a814eab3a29d1b3d90"
	},
	file: {
		id: "559b65d4e13d8265e982cd5a",
		href: "https://api.xvid.com/v1/files/559b65d4e13d8265e982cd5a"
	},
	extracted_data: [{
		autograph_tag: "test_tag",
        access_stats: [{
            ip_address: "5.9.119.0",
            ip_country: "Germany",
            ip_type: "DCH",
            user_agent: "Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.103 Safari/537.36",
            accept_language: "N/A",
            first_accessed_at: 1456099369000,
            percentage_obtained: "100%",
            highest_resolution: "720p",
            streaming_only: "no"
        }]
	}],
    application: {
        id: "54e89692e4b069d88de25f8f"
        href: "https://api.xvid.com/v1/applications/54e89692e4b069d88de25f8f"
    }
	status: "SUCCESS",
    percentage_completed: 100,
    error_msg: null,
    error_code: null,
	finished_at: 1436247563709,
	version: 1,
	user: {
		id: "552b874d14eab3a29d1b3d8d",
		href: "https://api.xvid.com/v1/users/552b874d14eab3a29d1b3d8d"
	},
	created_at: 1436247512758,
	updated_at: 1436247512758,
	id: "559b65d814eabe5486ff6ed5"
  }
  ],
  "total": 1,
  "start": 0,
  "limit": 1000
}
  • No labels