Work Order API

Work Order Description

To integrate with Closed Caption Creator using our Work Order API, you will need to generate a Work Order Description.

The Work Order Description is a straightforward JSON schema that outlines predefined properties, including project frame rate, media information, track details, and publishing specifications. This JSON data is then URL encoded and submitted as a GET request to https://app.closedcaptioncreator.com/workorder?description=*URL ENCODED WORK ORDER*.

For more information about each Work Order Description Property, please refer to our Work Order API video at the top of this page.

Example Work Order Description

{
    "task" : "edit",
    "projectName:" : "Trailer Test",
    "incode" : "01:00:00:00",
    "frameRate" : 29.97,
    "dropFrame" : true,
    "thumbnailUrl" : "https://cc-converter-test.s3.us-east-2.amazonaws.com/thumbnail.jpg",
    "mediaUrl" : "https://firebasestorage.googleapis.com/v0/b/closed-caption-creator-app.appspot.com/o/content%2Fvideo%2Ftrailer.mp4?alt=media&token=e18df7d3-610c-44db-a888-dd8604cbf27d",
    "mediaType" : "file",
    "tracks" : [
        {
            "type" : "subtitle",
            "status" : "Do Not Publish",
            "displayName" : "English Subtitles",
            "language" : "en-US",
            "rtl" : false,
            "maxCps" : 20,
            "maxWpm" : 250,
            "maxChars" : 32,
            "maxLines" : 2,
            "overlaps" : true, 
            "illegalChars" : true,
            "importOptions" : {
                "url" : "https://firebasestorage.googleapis.com/v0/b/closed-caption-creator-app.appspot.com/o/content%2Fvideo%2Ftrailer.webvtt?alt=media&token=4a7ca1b8-8cda-43e9-84d0-29adb663c132",
                "profile" : "webVtt",
                "options" : [],
                "frameRate" : 29.97,
                "dropFrame" : true
            },
            "publishOptions" : [{
                "url" : "https://httpbin.org/anything",
                "profile" : "scenerist",
                "options" : [],
                "offset" : "00:00:00:00",
                "offsetType" : "add",
                "auth" : true,
                "frameRate" : 29.97,
                "dropFrame" : true,
                "tcMultiplier" : 1
            }]
        }
    ],
    "importAlertSuccess" : {
        "title" : "Work Order Import",
        "text" : "The workorder was imported successfully!"
    },
    "importAlertError" : {
        "title" : "Work Order Import",
        "text" : "There was an error importing the work order. Please go back and try again."
    },
    "publishAlertSuccess" : {
        "title" : "Work Order Publish",
        "text" : "Publish Complete!"
    },
    "publishAlertError" : {
        "title" : "Work Order Publish",
        "text" : ":( There was an error publishing the work order."
    },
    "publishText" : "Please leave this window open while publishing",
    "redirectUrl" : "http://127.0.0.1:8000/",
    "publishOptions" : [{
        "url" : "https://httpbin.org/anything",
        "profile" : "scenerist",
        "options" : [],
        "offset" : "00:00:00:00",
        "offsetType" : "add",
        "auth" : true,
        "frameRate" : 29.97,
        "dropFrame" : true,
        "tcMultiplier" : 1
    }]
}

Account Management

By default, the user opening the work order must have a Closed Caption Creator account and an active subscription. Enterprise customers can circumvent this requirement by registering a Work Order Project and obtaining a unique token for the user. When a token is identified in a work order, it is matched with the Enterprise account, utilizing that account's subscription to authenticate the user.

Please contact our sales and support team to learn more about account management and subscription requirements.