In this article we provide examples of calls and responses relative to Sign language translation jobs in Reach integration flows.

Retrieving a task

Retrieving a machine Sign language translation job

Example of a response after requesting a job for a machine Sign language translation job using entryVendorTask.getJobs - Kaltura VPaaS API Documentation:

{
  "totalCount": 1,
  "objects": [
    {
      "id": "166232",
      "partnerId": 16332,
      "vendorPartnerId": 22391,
      "createdAt": 1749037440,
      "updatedAt": 1749037440,
      "queueTime": 1749037440,
      "entryId": "0_2hptmtlz",
      "status": 1,
      "reachProfileId": 1292,
      "catalogItemId": 2142,
      "price": 0,
      "userId": "first.last@kaltura.com",
      "entryObjectType": 1,
      "accessKey": "djJ8MTYyMzJ80qd2cWBeTMZB0S7UgtexP1-WvKhOVN1Ce5rE-oCqKIeZAD9ZAEvfTBWDRI1Xv9WHOvJ8wUScUALbjuzGfjbfviAjrrLkpPk8O2wRJlYZvTmZvBawRhnIQQ_j5Hi4Yj_nPVXl9-JkTDRfrjmNmaAnFHNCaXazVaSITWQRpiz94_m7KZIix8NnjgAJa3rlKhyIbL53aU5jwWGKfVOhiqfIraBY52AVj-UaptcUXzJI2Xggt_frynVoVK9PTXmHvRwnW7xY1JUwUjiIYLZrfiyZzQ==",
      "version": 12,
      "creationMode": 1,
      "expectedFinishTime": 1749642240,
      "serviceType": 2,
      "serviceFeature": 18,
      "turnAroundTime": -1,
      "objectType": "KalturaEntryVendorTask"
    }
  ],
  "objectType": "KalturaEntryVendorTaskListResponse"
}

Retrieving a machine Sign language translation task

Example of a response after requesting a task for a machine Sign language translation task using entryVendorTask.get - Kaltura VPaaS API Documentation:

{
  "relatedObjects": {
    "reach_vendor_catalog_item": {
      "totalCount": 1,
      "objects": [
        {
          "serviceType": 2,
          "serviceFeature": 18,
          "turnAroundTime": -1,
          "engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
          "sourceLanguage": "English",
          "allowResubmission": false,
          "payPerUse": false,
          "stage": 1,
          "contract": "",
          "createdBy": "User",
          "notes": "",
          "adminTagsToExclude": "",
          "targetLanguage": "English (BSL)",
          "outputFormat": "1",
          "objectType": "KalturaVendorSignLanguageCatalogItem"
        }
      ],
      "objectType": "KalturaVendorCatalogItemListResponse"
    },
    "reach_vendor_profile": {
      "totalCount": 1,
      "objects": [
        {
          "name": "default profile",
          "defaultOutputFormat": 1,
          "enableMetadataExtraction": true,
          "enableSpeakerChangeIndication": false,
          "enableAudioTags": false,
          "enableProfanityRemoval": true,
          "maxCharactersPerCaptionLine": 26,
          "labelAdditionForMachineServiceType": "",
          "labelAdditionForHumanServiceType": "",
          "contentDeletionPolicy": 2,
          "flavorParamsIds": "",
          "vendorTaskProcessingRegion": 1,
          "objectType": "KalturaReachProfile"
        }
      ],
      "objectType": "KalturaReachProfileListResponse"
    }
  },
  "id": "168542",
  "partnerId": 16232,
  "vendorPartnerId": 22891,
  "createdAt": 1749125377,
  "entryId": "0_i3i50ael",
  "status": 1,
  "reachProfileId": 1292,
  "catalogItemId": 2142,
  "price": 0,
  "accessKey": "djJ8MTYyMzJ8S37Eq_uNpSvW-d-qCrcTaEJNgSH6s7dJkGd9uNzLCpydWJhNJ7BGzcdJ5VjRgatYap1nwMKoaa6w4s4EEjoWRj_2a5l9Ecf_bZiD6KBskdzMZbg8RpSCDiEwp1wMNW8BOQ_WNOwphjKsFt5vfVoDwuER0Ew1a3Sx8Zo0sJMiJb9lLeNUi1Jbr6z8bLho0GTSl9iJG5oHdFoXoKqDI-HgSF9YYuffwFlMgOYN83jmc85RWTfFWekR46sWIM353HQA3fntzY85ozq4o2j3ac1-Fg==",
  "version": 12,
  "objectType": "KalturaEntryVendorTask"
}

Retrieving a Sign language catalog item

Example of a response after requesting catalog item details for a machine Sign language translation task using vendorCatalogItem.get - Kaltura VPaaS API Documentation:

{
  "id": 2142,
  "vendorPartnerId": 22391,
  "name": "English (BSL)",
  "systemName": "English BSL",
  "createdAt": 1748968038,
  "updatedAt": 1748968038,
  "status": 2,
  "serviceType": 2,
  "serviceFeature": 18,
  "turnAroundTime": -1,
  "pricing": {
    "pricePerUnit": 0,
    "priceFunction": "kReachUtils::calcPricePerMinute",
    "objectType": "KalturaVendorCatalogItemPricing"
  },
  "engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
  "sourceLanguage": "English",
  "allowResubmission": false,
  "payPerUse": false,
  "stage": 1,
  "contract": "",
  "createdBy": "User",
  "notes": "",
  "adminTagsToExclude": "",
  "targetLanguage": "English (BSL)",
  "outputFormat": "1",
  "objectType": "KalturaVendorSignLanguageCatalogItem"
}

Creating a child entry for Sign language

Example of an API call to create a child entry using media.add - Kaltura VPaaS API Documentation:

curl -X POST https://www.kaltura.com/api_v3/service/media/action/add \
    -d "ks=$KALTURA_SESSION" \
    -d "entry[objectType]=KalturaMediaEntry" \
    -d "entry[mediaType]=1" \
    -d "entry[sourceType]=5" \
    -d "entry[adminTags]=vendorname, signLangASL"

Example of an API response to creating a child entry:

{
  "id": "0_q50ibi1z",
  "name": "16232_1749038401",
  "description": "",
  "partnerId": 16332,
  "userId": "",
  "creatorId": "",
  "tags": "",
  "adminTags": "vendorname, signLangASL",
  "categories": "",
  "categoriesIds": "",
  "status": 7,
  "moderationStatus": 6,
  "moderationCount": 0,
  "type": 1,
  "createdAt": 1749038401,
  "updatedAt": 1749038401,
  "rank": 0,
  "totalRank": 0,
  "votes": 0,
  "downloadUrl": "https://www.kaltura.com/p/16232/sp/1623200/playManifest/entryId/0_q50ibi1z/format/download/protocol/https/flavorParamIds/0",
  "searchText": "_PAR_ONLY_ _16232_ _MEDIA_TYPE_1|  16232_1749038401 vendorname",
  "licenseType": -1,
  "version": 0,
  "thumbnailUrl": "https://cfvod.nvp.ovp.kaltura.com/p/16232/sp/1623200/thumbnail/entry_id/0_q50ibi1z/version/0",
  "accessControlId": 22362,
  "replacementStatus": 0,
  "partnerSortValue": 0,
  "rootEntryId": "0_q50ibi1z",
  "operationAttributes": [],
  "entitledUsersEdit": "",
  "entitledUsersPublish": "",
  "entitledUsersView": "",
  "capabilities": "",
  "displayInSearch": 1,
  "blockAutoTranscript": false,
  "plays": 0,
  "views": 0,
  "duration": 0,
  "msDuration": 0,
  "mediaType": 1,
  "sourceType": "5",
  "dataUrl": "https://api.nvp.ovp.kaltura.com/p/16232/sp/1623200/playManifest/entryId/0_q50ibi1z/format/url/protocol/https",
  "objectType": "KalturaMediaEntry"
}

 

Linking a child and parent entry

Example of an API call to link the child and parent entries using media.update - Kaltura VPaaS API Documentation:

curl -X POST https://www.kaltura.com/api_v3/service/media/action/update \
    -d "ks=$KALTURA_SESSION" \
    -d "entryId=0_q50ibi1z" \
    -d "mediaEntry[objectType]=KalturaMediaEntry" \
    -d "mediaEntry[parentEntryId]=0_2hptmtlz"

Example of an API response to linking a child and parent entry:

{
  "id": "0_q50ibi1z",
  "name": "16232_1749038401",
  "description": "",
  "partnerId": 16232,
  "userId": "",
  "creatorId": "",
  "tags": "",
  "adminTags": "vendorname, signLangASL",
  "categories": "",
  "categoriesIds": "",
  "status": 7,
  "moderationStatus": 6,
  "moderationCount": 0,
  "type": 1,
  "createdAt": 1749038401,
  "updatedAt": 1749038503,
  "rank": 0,
  "totalRank": 0,
  "votes": 0,
  "downloadUrl": "https://api.nvp.ovp.kaltura.com/p/16232/sp/1623200/playManifest/entryId/0_q50ibi1z/format/download/protocol/https/flavorParamIds/0",
  "searchText": "_NONE_ _16232_ _MEDIA_TYPE_1|  16232_1749038401 vendorname",
  "licenseType": -1,
  "version": 0,
  "thumbnailUrl": "https://cfvod.nvq2.ovp.kaltura.com/p/16232/sp/1623200/thumbnail/entry_id/0_q50ibi1z/version/0",
  "accessControlId": 22362,
  "replacementStatus": 0,
  "partnerSortValue": 0,
  "rootEntryId": "0_q50ibi1z",
  "parentEntryId": "0_2hptmtlz",
  "operationAttributes": [],
  "entitledUsersEdit": "0af38329e707b27e2ea1ab8d27fed9c1431b8a0da74f5d0d42b4695e208e0d9f",
  "entitledUsersPublish": "0af38329e707b27e2ea1ab8d27fed9c1431b8a0da74f5d0d42b4695e208e0d9f",
  "entitledUsersView": "0af38329e707b27e2ea1ab8d27fed9c1431b8a0da74f5d0d42b4695e208e0d9f",
  "capabilities": "",
  "displayInSearch": -1,
  "blockAutoTranscript": false,
  "plays": 0,
  "views": 0,
  "duration": 0,
  "msDuration": 0,
  "mediaType": 1,
  "sourceType": "5",
  "dataUrl": "https://api.nvp.ovp.kaltura.com/p/16232/sp/1623200/playManifest/entryId/0_q50ibi1z/format/url/protocol/https",
  "objectType": "KalturaMediaEntry"
}