Adding chapters (cuepoints)

In this article we provide examples of calls and responses relative to Chaptering jobs.

Retrieving a Chaptering job

Example of a response after requesting a job with the REACH profile information for a captions task using entryVendorTask.getJobs - Kaltura VPaaS API Documentation:

{
      "id": "473946412",
      "partnerId": 5215271,
      "vendorPartnerId": 5300373,
      "createdAt": 1729758199,
      "updatedAt": 1729758199,
      "queueTime": 1729758199,
      "entryId": "1_9lckaa3x",
      "status": 1,
      "reachProfileId": 228862,
      "catalogItemId": 18072,
      "price": 0,
      "userId": "user@abc.com",
      "accessKey": "djJ8NTIyNTE3MnzI3pREvEQWfRSkhlrk8XPY_jtnzEAQBv_CtIiXV-BJMldNocoWj6PWkBJ7mTDFEiJyFyyhTZ_ZSPbhBj-Mlf8vPdgs_Ufz-K3dgODnaqyqGReGPTvPBcafvN8U9D0n9h7qNlv2qmo3tVTg4152udpwL94DiTvJIvDQzRhw-P4g33in7VKWz-05MR3e6U1TGUzm5V59tXe1T20PLWQgYcilJX5VTZqzUSnSP90E2kCGtA==",
      "version": 11,
      "creationMode": 1,
      "expectedFinishTime": 1729807200,
      "serviceType": 2,
      "serviceFeature": 5,
      "turnAroundTime": 1,
      "objectType": "KalturaEntryVendorTask"
    }

Retrieving a Chaptering task

Example of a response after requesting a job with the REACH profile information for a captions task using entryVendorTask.get - Kaltura VPaaS API Documentation:

{
  "relatedObjects": {
    "reach_vendor_catalog_item": {
      "totalCount": 1,
      "objects": [
        {
          "serviceType": 2,
          "serviceFeature": 5,
          "turnAroundTime": 1,
          "engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
          "sourceLanguage": "English",
          "allowResubmission": false,
          "stage": 2,
          "contract": "none",
          "createdBy": "unknown",
          "notes": "none",
          "objectType": "KalturaVendorChapteringCatalogItem"
        }
      ],
      "objectType": "KalturaVendorCatalogItemListResponse"
    },
    "reach_vendor_profile": {
      "totalCount": 1,
      "objects": [
        {
          "name": "Ziotag REACH Customer Persona QA",
          "defaultOutputFormat": 1,
          "enableMetadataExtraction": true,
          "enableSpeakerChangeIndication": true,
          "enableAudioTags": true,
          "enableProfanityRemoval": true,
          "maxCharactersPerCaptionLine": 32,
          "labelAdditionForMachineServiceType": "",
          "labelAdditionForHumanServiceType": "",
          "contentDeletionPolicy": 2,
          "flavorParamsIds": "",
          "vendorTaskProcessingRegion": 1,
          "objectType": "KalturaReachProfile"
        }
      ],
      "objectType": "KalturaReachProfileListResponse"
    }
  },
  "id": "473946412",
  "partnerId": 5215271,
  "vendorPartnerId": 5300373,
  "createdAt": 1729758199,
  "entryId": "1_9lckaa3x",
  "status": 1,
  "reachProfileId": 228862,
  "catalogItemId": 18072,
  "accessKey": "djJ8NTIyNTE3MnzI3pREvEQWfRSkhlrk8XPY_jtnzEAQBv_CtIiXV-BJMldNocoWj6PWkBJ7mTDFEiJyFyyhTZ_ZSPbhBj-Mlf8vPdgs_Ufz-K3dgODnaqyqGReGPTvPBcafvN8U9D0n9h7qNlv2qmo3tVTg4152udpwL94DiTvJIvDQzRhw-P4g33in7VKWz-05MR3e6U1TGUzm5V59tXe1T20PLWQgYcilJX5VTZqzUSnSP90E2kCGtA==",
  "version": 11,
  "objectType": "KalturaEntryVendorTask"
}

Adding a cuepoint - Create a thumbnail chapter

Example of an API call to create a cuepoint using https://developer.kaltura.com/api-docs/service/cuePoint/action/add:

curl -X POST https://www.kaltura.com/api_v3/service/cuepoint_cuepoint/action/add \
    -d "ks=$KALTURA_SESSION" \
    -d "cuePoint[objectType]=KalturaThumbCuePoint" \
    -d "cuePoint[description]=Description" \
    -d "cuePoint[title]=title" \
    -d "cuePoint[subType]=2" \
    -d "cuePoint[entryId]=1_9lckaa3x" \
    -d "cuePoint[startTime]=9000" \
    -d "cuePoint[tags]=tagXYZ"