In this article we provide examples of calls and responses relative to Pay per use (PPU) jobs in Reach integration flows.
Retrieving a job
Retrieving a pay per use job
Example of a response after requesting a pay per use job using entryVendorTask.getJobs - Kaltura VPaaS API Documentation:
{
"id": "554305142",
"partnerId": 5482112,
"vendorPartnerId": 5434572,
"createdAt": 1756190813,
"updatedAt": 1756190813,
"queueTime": 1756190813,
"entryId": "1_gtms6qgv",
"status": 1,
"reachProfileId": 251412,
"catalogItemId": 39212,
"price": 0,
"userId": "user",
"entryObjectType": 1,
"accessKey": "djZ8NTQ4NjExMnx3KKn_6h7z3XFcc6aMJsuCQGvQUt5jjpCL0qXzn9OaTh17US64p5cKex85X8cVMgydOIovQDBugzg1pVfI2ko3_CJHN9SMdDC2CbhGYwSS1JHO8du52xvfdZBKoNSQ57eQWyxeFiKIfMDkHhWM3ur4IP6kez8Io6PtwF9HxYK3sWEUQuVrtokUVIcBUj_4QBIOV7Xct2gZ2nskvqEdWGEEsvOBD5aulH9yrYWBqogKRg==",
"version": 11,
"creationMode": 1,
"expectedFinishTime": 1756536413,
"serviceType": 1,
"serviceFeature": 9,
"turnAroundTime": 345600,
"objectType": "KalturaEntryVendorTask"
}
],
"objectType": "KalturaEntryVendorTaskListResponse"
}
Retrieving a pay per use task
Example of a response after requesting a task for a pay per use task using entryVendorTask.get - Kaltura VPaaS API Documentation:
{
"relatedObjects": {
"reach_vendor_catalog_item": {
"totalCount": 1,
"objects": [
{
"serviceType": 1,
"serviceFeature": 9,
"turnAroundTime": 345600,
"engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
"sourceLanguage": "English",
"allowResubmission": false,
"payPerUse": true,
"stage": 2,
"contract": "",
"createdBy": "",
"notes": "",
"adminTagsToExclude": "",
"flavorParamsId": 0,
"clearAudioFlavorParamsId": 0,
"outputFormat": "3",
"objectType": "KalturaVendorExtendedAudioDescriptionCatalogItem"
}
],
"objectType": "KalturaVendorCatalogItemListResponse"
},
"reach_vendor_profile": {
"totalCount": 1,
"objects": [
{
"name": "Reach test",
"defaultOutputFormat": 1,
"enableMetadataExtraction": true,
"enableSpeakerChangeIndication": false,
"enableAudioTags": false,
"enableProfanityRemoval": true,
"maxCharactersPerCaptionLine": 26,
"labelAdditionForMachineServiceType": "",
"labelAdditionForHumanServiceType": "",
"contentDeletionPolicy": 2,
"flavorParamsIds": "",
"vendorTaskProcessingRegion": 1,
"objectType": "KalturaReachProfile"
}
],
"objectType": "KalturaReachProfileListResponse"
}
},
"id": "554305142",
"partnerId": 5482112,
"vendorPartnerId": 5434572,
"createdAt": 1756190813,
"entryId": "1_gtms6qgv",
"status": 1,
"reachProfileId": 251412,
"catalogItemId": 39212,
"accessKey": "djZ8NTQ4NjExMnx3KKn_6h7z3XFcc6aMJsuCQGvQUt5jjpCL0qXzn9OaTh17US64p5cKex85X8cVMgydOIovQDBugzg1pVfI2ko3_CJHN9SMdDC2CbhGYwSS1JHO8du52xvfdZBKoNSQ57eQWyxeFiKIfMDkHhWM3ur4IP6kez8Io6PtwF9HxYK3sWEUQuVrtokUVIcBUj_4QBIOV7Xct2gZ2nskvqEdWGEEsvOBD5aulH9yrYWBqogKRg==",
"version": 11,
"objectType": "KalturaEntryVendorTask"
}
In the task we can see "payPerUse": true which indicates this order was placed against a Pay per use catalog item.
Updating a Pay per use task using update.add
Example of an API call to update a Pay per use task using update.add - Kaltura VPaaS API Documentation:
curl -X POST https://www.kaltura.com/api_v3/service/reach_entryvendortask/action/update \ -d "ks=$KALTURA_SESSION" \ -d "format=1" -d "id=554305142" -d "entryVendorTask[objectType]=KalturaEntryVendorTask" -d "entryVendorTask[unitsUsed]=6"
Example of an API response to updating a Pay per use task:
{
"id": "554305142",
"partnerId": 5482112,
"vendorPartnerId": 5434572,
"createdAt": 1756190813,
"updatedAt": 1756191021,
"queueTime": 1756190813,
"entryId": "1_gtms6qgv",
"status": 1,
"reachProfileId": 251412,
"catalogItemId": 39212,
"price": 0,
"userId": "",
"entryObjectType": 1,
"unitsUsed": 6,
"accessKey": "djZ8NTQ4NjExMnx3KKn_6h7z3XFcc6aMJsuCQGvQUt5jjpCL0qXzn9OaTh17US64p5cKex85X8cVMgydOIovQDBugzg1pVfI2ko3_CJHN9SMdDC2CbhGYwSS1JHO8du52xvfdZBKoNSQ57eQWyxeFiKIfMDkHhWM3ur4IP6kez8Io6PtwF9HxYK3sWEUQuVrtokUVIcBUj_4QBIOV7Xct2gZ2nskvqEdWGEEsvOBD5aulH9yrYWBqogKRg==",
"version": 11,
"creationMode": 1,
"expectedFinishTime": 1756536413,
"serviceType": 1,
"serviceFeature": 9,
"turnAroundTime": 345600,
"objectType": "KalturaEntryVendorTask"
}
Updating usage on a Pay per use task using updateJob
Example of an API call to update a Pay per use task using updateJob- Kaltura VPaaS API Documentation:
curl -X POST https://www.kaltura.com/api_v3/service/reach_entryvendortask/action/updateJob \ -d "ks=$KALTURA_SESSION" \ -d "format=1" -d "id=554305142" -d "entryVendorTask[objectType]=KalturaEntryVendorTask" -d "entryVendorTask[unitsUsed]=180000"
The usage you report back is in milliseconds. For example when you want so send back a usage of 3 minutes, you should send back a usage of 180000, which is 3 minutes in milliseconds.
Example of an API response to updating usage on a Pay per use job:
{
"id": "554305142",
"partnerId": 5486112,
"vendorPartnerId": 5484572,
"createdAt": 1756190813,
"updatedAt": 1756193688,
"queueTime": 1756190813,
"entryId": "1_gtms6qgv",
"status": 9,
"reachProfileId": 251412,
"catalogItemId": 39212,
"price": 0,
"userId": "",
"entryObjectType": 1,
"unitsUsed": 180000,
"accessKey": "djZ8NTQ4NjExMnx3KKn_6h7z3XFcc6aMJsuCQGvQUt5jjpCL0qXzn9OaTh17US64p5cKex85X8cVMgydOIovQDBugzg1pVfI2ko3_CJHN9SMdDC2CbhGYwSS1JHO8du52xvfdZBKoNSQ57eQWyxeFiKIfMDkHhWM3ur4IP6kez8Io6PtwF9HxYK3sWEUQuVrtokUVIcBUj_4QBIOV7Xct2gZ2nskvqEdWGEEsvOBD5aulH9yrYWBqogKRg==",
"version": 11,
"creationMode": 1,
"expectedFinishTime": 1756536413,
"serviceType": 1,
"serviceFeature": 9,
"turnAroundTime": 345600,
"objectType": "KalturaEntryVendorTask"
}
Updating vendor comments on a Pay per use task using update.add
Example of an API call to update a Pay per use task using updateJob- Kaltura VPaaS API Documentation:
curl -X POST https://www.kaltura.com/api_v3/service/reach_entryvendortask/action/updateJob \ -d "ks=$KALTURA_SESSION" \ -d "format=1" -d "id=322539432" -d "entryVendorTask[objectType]=KalturaEntryVendorTask" -d "entryVendorTask[taskJobData][objectType]=KalturaAudioDescriptionVendorTaskData" -d "entryVendorTask[taskJobData][vendorComment]=blablabla"
Possible values for entryVendorTask[taskJobData][objectType] include (not exhaustive): KalturaAudioDescriptionVendorTaskData, KalturaCaptionVendorTaskData, KalturaDubbingVendorTaskData, KalturaTranslationVendorTaskData
The vendor comment can include text or json, it is typically used to report specific information about the task.
Example of an API response to updating vendorComments on a Pay per use job:
{ "id": "322539432", "partnerId": 5426115, "vendorPartnerId": 2484472, "createdAt": 1692268177, "updatedAt": 1787139492, "queueTime": 1692268177, "entryId": "1_eyl6k4e0", "status": 1, "reachProfileId": 251412, "catalogItemId": 20632, "price": 0, "userId": "c82fb0fcaaaba215b7a17b9e8e7ea751", "entryObjectType": 1, "accessKey": "ajJ8NTQ4NjExEnw119DzfvZL-SuE0Yf0HxhamvkIafq2vN9K2StMLWB5nfBD3N-0zHWtOvE8eBoqgGd5sqLFfGRbIteVkS-PxySPLd6j9mMRJ7mBJmRjVEHAawkPfRpgvMNyJ8OMP6PmVviBEFg745y2ECxhQOVofKzsbAO2WDuVibEci0ZnnFw-O7ZBIDd2ha6a696vnIvMrrpyR-a7UYjoBKPu8KWfaPZbdLt3zzIcLYXVBb06H_q0EQ==", "version": 11, "creationMode": 1, "taskJobData": { "vendorComment": "blablabla", "objectType": "KalturaAudioDescriptionVendorTaskData" }, "expectedFinishTime": 1692872977, "serviceType": 2, "serviceFeature": 1, "turnAroundTime": -1, "objectType": "KalturaEntryVendorTask" }
