Language API

Language Listing

Path: https://dotsub.com/api/language

Method: GET

Shows a listing of the languages supported by Dotsub.

Example Response

{
    "languages":{
        "abk":"Abkhaz",
        "ace":"Aceh (Achenese)",
        "ach":"Acholi (Acoli)",
        "ady":"Adyghe (Adygei)",
        "aar":"Afar",
        "afh":"Afrihili",
        "afr":"Afrikaans",
        "afa":"Afro-Asiatic",
        "ain":"Ainu",
        "aka":"Akan",
        "akk":"Akkadian",
        "alb":"Albanian",
        "ale":"Aleut",
        "alg":"Algonquian languages",
        "alt":"Altai, Southern"
    …
    }
}

Language Mapping

Path: https://dotsub.com/api/language?code=$languageCode

Method: GET

Some sites use ISO-693-2 others use ISO-693-3 language codes. This method provides an API method to map these codes to Dotsub's language codes. You can send any code to Dotsub and it will reply with the code that should be used to load that language on Dotsub.com

Example Response

{
    "language": {
        "direction": "ltr",
        "iso2Code": "en",
        "legacyCodes": [
            "en"
        ],
        "languageNameLocalized": "English",
        "languageName": "English",
        "iso3Code": "eng"
    }
}

Media API

Upload

Path: https://dotsub.com/api/media

Method: POST

You can upload media to Dotsub from your system using a HTTP Post to our media upload API. This form does require you to be authenticated.

Request Parameters

Example Response

{
  "status": {
    "message": "Media created",
    "error": false,
    "uuid": "b98b2559-5440-4eef-bd22-a4e482f5ebe6",
    "code": 200
  }
}

Metadata

Path: https://dotsub.com/api/media/$UUID or https://dotsub.com/api/user/$username/media/$externalIdentifier

Method: GET

You can retrieve the metadata of a given media via this call.

Request Parameters

Example Response

{
  "genre": "genre.publicServiceAnnouncement",
  "numberOfViews": 82519,
  "numberOfLanguages": 2,
  "numberOfTranslations": 1,
  "languages": {
    "eng": {
      "workflowStatus": null,
      "lastModified": 1188338461138,
      "languageNameLocalized": "English",
      "properties": {

      },
      "languageName": "English",
      "languageCode": "eng",
      "percentageComplete": 100,
      "title": "Sample Video",
      "level": "professional",
      "description": "Orbiting the sun at about 98 million miles is a little blue planet and this planet is run by a bunch of monkeys.\n\n Now, the monkeys don't think of themselves as monkeys...\n ",
      "workflowStatusLastModified": 0,
      "languageDirection": "ltr",
      "dateCreated": 1188334861138,
      "actors": {

      }
    },
    "spa": {
      "workflowStatus": null,
      "lastModified": 1188331261138,
      "languageNameLocalized": "Espa\u00f1ol",
      "languageName": "Spanish",
      "languageCode": "spa",
      "percentageComplete": 100,
      "title": "Video Ejemplo",
      "level": "human",
      "description": "El sol en \u00f3rbita alrededor de 98 millones de millas es un peque\u00f1o planeta azul y el planeta es\n dirigido por un grupo de monos. Ahora, los monos no se ven a s\u00ed mismos como los monos ...\n ",
      "workflowStatusLastModified": 0,
      "languageDirection": "ltr",
      "dateCreated": 1188324061138,
      "actors": {
        "REVISOR": "otheruser",
        "TRANSLATOR": "user"
      }
    }
  },
  "screenshotURI": "http:\/\/dotsub.com\/media\/af0e8151-f78a-4168-8712-9cc6f8b9e2dc\/p",
  "title": "Dance, Monkeys, Dance by Ernie Cline",
  "description": "Orbiting the sun at about 98 million miles is a little blue planet and this planet is run by a bunch of monkeys.\n\n Now, the monkeys don't think of themselves as monkeys...\n ",
  "type": "LocalMedia",
  "license": {
    "description": "By selecting \"Other\" your media is licensed under the dotSUB terms of service",
    "id": "a2be14e0-37d9-11dd-ae16-0800200c9a66",
    "name": "dotSUB - Other",
    "url": "http:\/\/dotsub.com\/termsOfUse.jsp"
  },
  "displayURI": "http:\/\/dotsub.com\/view\/af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
  "workflowStatus": "READY",
  "transcriptionStatus": "COMPLETED",
  "lastModified": 1156957261138,
  "transcriptionCompletion": 100,
  "isPublic": true,
  "director": null,
  "duration": 233000,
  "producer": null,
  "translateURIPattern": "http:\/\/dotsub.com\/translate\/af0e8151-f78a-4168-8712-9cc6f8b9e2dc\/",
  "dateCreated": 1156957261138,
  "externalIdentifier": "625719",
  "uuid": "af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
  "language": "eng",
  "user": "user"
}

Metadata Editing

Path: https://dotsub.com/api/media/$UUID or https://dotsub.com/api/user/$username/media/$externalIdentifier

Method: POST

You can update the metadata for a media via this call. Any omitted fields will retain their existing values.

Request Parameters

Example Response

{
  "status": {
    "message": "Media Metadata Updated",
    "error": false,
    "code": 200
  }
}

Media Delete

Path: https://dotsub.com/api/media/$UUID or https://dotsub.com/api/user/$username/media/$externalIdentifier

Method: DELETE

A media can be removed from the system using this API call.

Example Response

{
  "status": {
    "message": "Media Deleted",
    "error": false,
    "code": 200
  }
}

Captions API

Caption Listing

Path: https://dotsub.com/api/media/$UUID/captions?language=$languageCode or https://dotsub.com/api/user/$username/media/$externalIdentifier/captions?language=$languageCode

Method: GET

You can retrieve the captions of a given media in a selected language via this call. The captions will be returned if they exist. If there are no captions in the selected language an error will be returned.

Example Response

{
  "captions": [
    {
      "content": "There are billions of galaxies in the observable universe",
      "startTime": 7000,
      "duration": 3000,
      "startOfParagraph": false
    },
    {
      "content": "And each of them contains hundreds of billions of stars",
      "startTime": 10000,
      "duration": 4000,
      "startOfParagraph": false
    },
    …
    {
      "content": "They want to be something else But they're not.",
      "startTime": 231000,
      "duration": 3000,
      "startOfParagraph": false
    }
  ]
}

Transcription Upload

Path: https://dotsub.com/api/media/$UUID/transcription or https://dotsub.com/api/user/$username/media/$externalIdentifier/transcription

Method: POST

You can upload an existing caption file as the video transcription. Most standard subtitle formats are supported (ex: SRT, WebVTT, Timed Text).

Request Parameters

Example Response

{
  "status": {
    "message": "File imported",
    "error": false,
    "code": 200
  }
}

Translation Upload

Path: https://dotsub.com/api/media/$UUID/translation or https://dotsub.com/api/user/$username/media/$externalIdentifier/translation

Method: POST

You can upload an existing caption file as a video translation. Most standard subtitle formats are supported (ex: SRT, WebVTT, Timed Text).

Please note: Dotsub requires the timing of a translation to exactly match the timing of the transcription.

Request Parameters

Example Response

{
  "status": {
    "message": "File imported",
    "error": false,
    "code": 200
  }
}

Transcription Quality Level

Path: https://dotsub.com/api/media/$UUID/transcription or https://dotsub.com/api/user/$username/media/$externalIdentifier/transcription

Method: POST

You can tag the quality level of a transcription using this API. This value will be returned in all metadata calls for future use.

Request Parameters

Example Response

{
  "status": {
    "message": "Transcription Level Set",
    "error": false,
    "code": 200
  }
}

Translation Quality Level

Path: https://dotsub.com/api/media/$UUID/translation or https://dotsub.com/api/user/$username/media/$externalIdentifier/translation

Method: POST

You can tag the quality level of a translation using this API. This value will be returned in all metadata calls for future use.

Request Parameters

Example Response

{
  "status": {
    "message": "Translation Level Set",
    "error": false,
    "code": 200
  }
}

Translation/Transcription File Download

Path: https://dotsub.com/media/$UUID/c/$languageCode/$format or https://dotsub.com/media/u/$username/$externalIdentifier/c/$languageCode/$format

Method: POST

Translation and transcription files can be downloaded from Dotsub using the following requests. Any private videos will require you to be authenticated to download.

Request Parameters

License API

License Listing

Path: https://dotsub.com/api/license

Method: GET

Shows a listing of the video licenses supported by Dotsub.

Example Response

{
  "licenses": [
    {
      "active": true,
      "description": "dotSUB has adopted the 'CC-Attribution Non-Commercial No Derivatives' license as our default license. This license is the most restrictive of the six main CC licenses, allowing redistribution. This license is often called the 'free advertising' license because it allows others to download your works and share them with others as long as they mention you and link back to you, but they can't change them in any way or use them commercially.",
      "id": "a2be14e1-37d9-11dd-ae16-0800200c9a66",
      "licenseVersion": "3.0",
      "name": "CC - Attribution Non-commercial No Derivatives",
      "url": "http:\/\/creativecommons.org\/licenses\/by-nc-nd\/3.0\/"
    },
    …
    {
      "active": true,
      "description": "\"All rights reserved\" indicates that the copyright holder reserves, or holds for their own use, all the rights provided by copyright law, such as distribution, performance, and creation of derivative works; and they have not waived any such right.",
      "id": "ffc28f46-e302-450a-907b-c818f9eaf54f",
      "licenseVersion": "1.0",
      "name": "All rights reserved",
      "url": ""
    }
  ]
}

Media Workflow

Path: https://dotsub.com/api/media/$UUID/workflow or https://dotsub.com/api/user/$username/media/$externalIdentifier/workflow

Method: POST

Changes can be made to the workflow state of translations and transcriptions via this API.

Example Response

{
  "status": {
    "message": "Workflow Status Set",
    "error": false,
    "code": 200
  }
}

Captioning API

The captioning API allows you to add/edit/remove items from a videos captions. This API can be used to create you own captioning experience.

Add Caption

Path: https://dotsub.com/api/media/$UUID/transcription/items

Method: POST

Adds an item to a transcription.

Example Response

{
   "status":{
      "message":"Caption Added",
      "error":false,
      "code":200
   },
   "item":{
      "content":"A wonderful little caption",
      "duration":2000,
      "id":"2f720dd6-16a5-461b-af32-1f22a78605b7",
      "startOfParagraph":false,
      "startTime":0
   }
}

Edit Caption

Path: https://dotsub.com/api/media/$UUID/transcription/items/$captionId

Method: POST

Edits an existing item in a transcription.

Example Response

{
   "status":{
      "message":"Caption Updated",
      "error":false,
      "code":200
   },
   "item":{
      "content":"A wonderful little edit",
      "duration":2000,
      "id":"2f720dd6-16a5-461b-af32-1f22a78605b7",
      "startOfParagraph":false,
      "startTime":0
   }
}

Delete Caption

Path: https://dotsub.com/api/media/$UUID/transcription/items/$captionId

Method: DELETE

Deletes an existing item in a transcription.

Example Response

{
   "status":{
      "message":"Caption Deleted",
      "error":false,
      "code":200
   }
}

List Captions

Path: https://dotsub.com/api/media/$UUID/transcription/items

Method: GET

Lists all items in a transcription.

Example Response

{
   "items":[
      {
         "content":"You've seen the word, you've seen the websites,",
         "duration":2000,
         "id":"9991",
         "startOfParagraph":false,
         "startTime":0
      },
      {
         "content":"and you may even have one.",
         "duration":2000,
         "id":"9992",
         "startOfParagraph":false,
         "startTime":2000
      },
      {
         "content":"But have you ever wondered, what's the big deal about blogs?",
         "duration":3000,
         "id":"9993",
         "startOfParagraph":false,
         "startTime":4000
      }
   ]
}

Add Translation

Path: https://dotsub.com/api/media/$UUID/translation/$languageCode/items

Method: POST

Adds an item to a translation.

Example Response

{
   "status":{
      "message":"Translation Item Added",
      "error":false,
      "code":200
   },
   "item":{
      "content":"Foo",
      "duration":2000,
      "id":"1a82ce49-5ed5-4935-a039-1d848c5f4c92",
      "locale":"fin",
      "startOfParagraph":false,
      "startTime":2000
   }
}

Edit Translation

Path: https://dotsub.com/api/media/$UUID/translation/$langaugeCode/items/$translationId

Method: POST

Edits an existing item in a translation.

Example Response

{
   "status":{
      "message":"Translation Item Updated",
      "error":false,
      "code":200
   },
   "item":{
      "content":"Foo",
      "duration":2000,
      "id":"1198adf8-30a1-4d54-9774-179c825cc80a",
      "locale":"fin",
      "startOfParagraph":false,
      "startTime":2000
   }
}

Delete Translation

Path: https://dotsub.com/api/media/$UUID/translation/$languageCode/items/$translationID

Method: DELETE

Deletes an existing item in a translation.

Example Response

{
   "status":{
      "message":"Translation Item Deleted",
      "error":false,
      "code":200
   }
}

List Translation

Path: https://dotsub.com/api/media/$UUID/translation/$langaugeCode/items

Method: GET

Lists all items in a translation.

Example Response

{
   "items":[
      {
         "content":"Hay millones d galaxias en el universo que vemos",
         "duration":3000,
         "id":"201",
         "locale":"spa",
         "startOfParagraph":false,
         "startTime":7000
      },
      {
         "content":"Y cada una de ellas contiene billones de estrellas",
         "duration":4000,
         "id":"202",
         "locale":"spa",
         "startOfParagraph":false,
         "startTime":10000
      },
      {
         "content":"En una de estas galaxias",
         "duration":2000,
         "id":"203",
         "locale":"spa",
         "startOfParagraph":false,
         "startTime":14000
      },
      {
         "content":"Orbitando una de estas estrellas",
         "duration":2000,
         "id":"204",
         "locale":"spa",
         "startOfParagraph":false,
         "startTime":16000
      },
      {
         "content":"Hay un planeta azul",
         "duration":2000,
         "id":"205",
         "locale":"spa",
         "startOfParagraph":false,
         "startTime":18000
      }
   ]
}

Project API

Project Listing

Path: https://dotsub.com/api/project

Method: GET

The project listing API will list all projects a user currently manages.

Example Response

{
  "projects": [
    {
      "id": "46f16bf2-84e7-11dd-8608-f3f9661facd6",
      "title": "Sample Project One"
    },
    {
      "id": "99e514b0-8b29-11dd-ad8b-0800200c9a66",
      "title": "Test Project Two"
    }
  ]
}

Project Media Listing

Path: https://dotsub.com/api/project/$projectId/media

Method: GET

The project media API will list all media in a given project.

Request Parameters

Example Response

{
  "limit": 20,
  "sort": "dateCreated",
  "results": 2,
  "start": 0,
  "dir": "DESC",
  "media": [
    {
      "dateCreated": 1188320461138,
      "externalIdentifier": "",
      "id": "9f0e8151-f78a-4168-b712-9006f8b9e2dc",
      "language": "eng",
      "lastModified": 1219942861138,
      "numberOfTranslations": 0,
      "numberOfViews": 876,
      "title": "Conversion Failed",
      "workflowStatus": "PROCESSING_FAILED"
    },
    {
      "dateCreated": 1156957261138,
      "externalIdentifier": "625719",
      "id": "af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
      "language": "eng",
      "lastModified": 1156957261138,
      "numberOfTranslations": 2,
      "numberOfViews": 82519,
      "title": "Test Video One",
      "workflowStatus": "READY"
    }
  ]
}

Add Media to Project

Path: https://dotsub.com/api/project/$projectId/media

Method: PUT

The project add media API allows you to add videos from your project on Dotsub.

Request Parameters

Example Response

{
  "status": {
    "message": "Media added to project",
    "error": false,
    "code": 200
  }
}

Remove Media from Project

Path: https://dotsub.com/api/project/$projectId/media

Method: DELETE

The project remove media API allows you to remove videos from your project on Dotsub.

Request Parameters

Example Response

{
  "status": {
    "message": "Media removed from project",
    "error": false,
    "code": 200
  }
}

Project Transcribers/Translators

Path: https://dotsub.com/api/project/$projectId/transcribers and https://dotsub.com/api/project/$projectId/translators

Method: GET

This API allows you to get the list of transcribers and translators working on your Dotsub project.

Request Parameters

Example Response

{
  "results": 1,
  "users": [
    {
      "email": "[email protected]",
      "enabled": true,
      "firstName": "Joe",
      "fullName": "Joe User",
      "lastName": "User",
      "username": "user"
    }
  ]
}

Project Transcribers/Translators Details

Path: https://dotsub.com/api/project/$projectId/transcribers/$username and https://dotsub.com/api/project/$projectId/translators/$username

Method: GET

This API allows you to get the listing of the work for a single user in your project.

Example Response

{
  "translations": [
    {
      "actors": {
        "TRANSLATOR": {
          "email": "[email protected]",
          "enabled": true,
          "firstName": "Joe",
          "fullName": "Joe User",
          "lastName": "User",
          "username": "user"
        }
      },
      "languageCode": "spa",
      "languageName": "Spanish",
      "lastModified": 1188331261138,
      "level": "human",
      "mediaExtId": "",
      "mediaLength": "3:53",
      "mediaLengthValue": 233000,
      "mediaTitle": "Sample Video One",
      "mediaUuid": "af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
      "percentageComplete": 0,
      "workflowStatus": null,
      "workflowStatusLastModified": 0
    },
    {
      "actors": {
        "TRANSLATOR": {
          "email": "[email protected]",
          "enabled": true,
          "firstName": "Joe",
          "fullName": "Joe User",
          "lastName": "User",
          "username": "user"
        }
      },
      "languageCode": "ara",
      "languageName": "Arabic",
      "lastModified": 1188417661138,
      "level": "",
      "mediaExtId": "",
      "mediaLength": "3:53",
      "mediaLengthValue": 233000,
      "mediaTitle": "Sample Video One",
      "mediaUuid": "af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
      "percentageComplete": 0,
      "workflowStatus": null,
      "workflowStatusLastModified": 0
    }
  ]
}

Project Users

The project user API is a feature that can be enabled on Dotsub for your project. This will allow you to only assign work to the users you have added to a given project. Users can be added to a project via the dashboard or an API call.

Add/Update Project Users

Path: https://dotsub.com/api/project/$projectId/users

Method: POST

This call adds or updates a user. If a user already exists in a project this API call will update their list of languages, appending any new values. If they do not exist in the project they will be added.

Request Parameters

Example Response

{
  "status": {
    "message": "User record added to project",
    "error": false,
    "code": 200
  }
}

Remove Project User

Path: https://dotsub.com/api/project/$projectId/users

Method: DELETE

This call removes a user from a project.

Request Parameters

Example Response

{
  "status": {
    "message": "User record removed from project",
    "error": false,
    "code": 200
  }
}

Listing Project Users

Path: https://dotsub.com/api/project/$projectId/users

Method: GET

This API allows you to get the list of users and languages you have added to a project.

Request Parameters

Example Response

{
  "limit": 20,
  "sort": "username",
  "projectUsers": [
    {
      "languageNames": [
        "Finnish",
        "Spanish"
      ],
      "languages": [
        "fin",
        "spa"
      ],
      "user": {
        "email": "[email protected]",
        "emailUser": true,
        "firstName": "Joe",
        "fullName": "Joe User",
        "lastName": "User",
        "username": "user"
      }
    },
    {
      "languageNames": [
        "Arabic",
        "Spanish"
      ],
      "languages": [
        "ara",
        "spa"
      ],
      "user": {
        "email": "[email protected]",
        "emailUser": true,
        "firstName": "Bill",
        "fullName": "Bill User",
        "lastName": "User",
        "username": "otheruser"
      }
    }
  ],
  "results": 2,
  "start": 0,
  "dir": "DESC"
}

Order API

Dotsub's order API allows you to send caption/translation orders to Dotsub. Any video already uploaded to your account/project can be used in an order. You can also use this API check the status of historical orders.

Order Listing

Path: https://dotsub.com/api/order

Method: GET

The orders listing API will list all orders for a user.

Request Parameters

Example Response

{
  "limit": 20,
  "orders": [
    {
      "completionDate": 1359741601138,
      "createdBy": "user",
      "dateCreated": 1358013601138,
      "discount": 0,
      "id": "674acc50-58e0-11e2-bcfd-0800200c9a66",
      "invoiceNumber": "",
      "orderItems": [
        {
          "completionDate": 1357834261138,
          "dateCreated": 1357575060138,
          "deliveryDate": 0,
          "id": "f5bfbba0-58e3-11e2-bcfd-0800200c9a66",
          "itemType": "TranslationOrderItem",
          "language": "fin",
          "languageName": "Finnish",
          "mediaExternalIdentifier": "625719",
          "mediaId": "af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
          "mediaTitle": "Dance, Monkeys, Dance by Ernie Cline",
          "orderId": "674acc50-58e0-11e2-bcfd-0800200c9a66",
          "orderNumber": "242",
          "orderStatus": "PENDING",
          "percentageComplete": 0,
          "period": null,
          "price": 0,
          "subtitleSpecification": null,
          "videoMinutes": 4
        },
        {
          "completionDate": 1357834261138,
          "dateCreated": 1357575061138,
          "deliveryDate": 0,
          "id": "f5bfbba1-58e3-11e2-bcfd-0800200c9a66",
          "itemType": "TranslationOrderItem",
          "language": "dan",
          "languageName": "Danish",
          "mediaExternalIdentifier": "625719",
          "mediaId": "af0e8151-f78a-4168-8712-9cc6f8b9e2dc",
          "mediaTitle": "Dance, Monkeys, Dance by Ernie Cline",
          "orderId": "674acc50-58e0-11e2-bcfd-0800200c9a66",
          "orderNumber": "242",
          "orderStatus": "PENDING",
          "percentageComplete": 0,
          "period": null,
          "price": 0,
          "subtitleSpecification": null,
          "videoMinutes": 4
        }
      ],
      "orderNumber": 242,
      "orderSource": null,
      "orderStatus": "PENDING",
      "price": 0,
      "projectId": "46f16bf2-84e7-11dd-8608-f3f9661facd6",
      "projectName": "Sample Project One",
      "totalItems": 2,
      "videoMinutes": 8
    }
  ],
  "sort": "dateCreated",
  "results": 1,
  "start": 0,
  "dir": "DESC"
}

Create Order

Path: https://dotsub.com/api/order

Method: POST

This call allows you to create an order.

Request Parameters

Example Response

{
  "order": {
    "completionDate": 1359987982322,
    "createdBy": "user",
    "dateCreated": 1359469582270,
    "id": "fb54467a-08d8-4072-a5e6-8d3612559d2d",
    "orderItems": [
      {
        "completionDate": 1359555982322,
        "dateCreated": 1359469582274,
        "id": "f4d737dc-58de-499e-ba2d-6af9baae3982",
        "itemType": "TranscriptionOrderItem",
        "language": "eng",
        "languageName": "English",
        "mediaExternalIdentifier": "",
        "mediaId": "44c79590-42d9-11dd-ae16-0800200c9a66",
        "mediaTitle": "Dotsub Google Translate screencast",
        "orderId": "fb54467a-08d8-4072-a5e6-8d3612559d2d",
        "orderStatus": "PENDING",
        "videoMinutes": 2
      },
      {
        "completionDate": 1359987982322,
        "dateCreated": 1359469582275,
        "id": "3a96f239-7a1c-4992-9cc6-2f24de09e093",
        "itemType": "TranslationOrderItem",
        "language": "ger",
        "languageName": "German",
        "mediaExternalIdentifier": "",
        "mediaId": "44c79590-42d9-11dd-ae16-0800200c9a66",
        "mediaTitle": "Dotsub Google Translate screencast",
        "orderId": "fb54467a-08d8-4072-a5e6-8d3612559d2d",
        "orderStatus": "PENDING",
        "videoMinutes": 2
      }
    ],
    "orderStatus": "PENDING",
    "projectId": "",
    "projectName": "",
    "totalItems": 2,
    "videoMinutes": 4
  }
}

Order Details

Path: https://dotsub.com/api/order/$UUID

Method: GET

This call allows you to create an order.

Example Response

{
  "order": {
    "completionDate": 1359987982322,
    "createdBy": "user",
    "dateCreated": 1359469582270,
    "id": "fb54467a-08d8-4072-a5e6-8d3612559d2d",
    "orderItems": [
      {
        "completionDate": 1359555982322,
        "dateCreated": 1359469582274,
        "id": "f4d737dc-58de-499e-ba2d-6af9baae3982",
        "itemType": "TranscriptionOrderItem",
        "language": "eng",
        "languageName": "English",
        "mediaExternalIdentifier": "",
        "mediaId": "44c79590-42d9-11dd-ae16-0800200c9a66",
        "mediaTitle": "Dotsub Google Translate screencast",
        "orderId": "fb54467a-08d8-4072-a5e6-8d3612559d2d",
        "orderStatus": "PENDING",
        "videoMinutes": 2
      },
      {
        "completionDate": 1359987982322,
        "dateCreated": 1359469582275,
        "id": "3a96f239-7a1c-4992-9cc6-2f24de09e093",
        "itemType": "TranslationOrderItem",
        "language": "ger",
        "languageName": "German",
        "mediaExternalIdentifier": "",
        "mediaId": "44c79590-42d9-11dd-ae16-0800200c9a66",
        "mediaTitle": "Dotsub Google Translate screencast",
        "orderId": "fb54467a-08d8-4072-a5e6-8d3612559d2d",
        "orderStatus": "PENDING",
        "videoMinutes": 2
      }
    ],
    "orderStatus": "PENDING",
    "projectId": "",
    "projectName": "",
    "totalItems": 2,
    "videoMinutes": 4
  }
}

Order Items

An order contains one or more 'Order Items'. These are the transcriptions/translations in the order. These are sent to the server in the following format

<type>,<id>,<language>

Parameters

Downloading Items

Path: https://dotsub.com/api/order/$orderId/items/$orderItemId/download

Method: GET

You can get the download URL for your order items by using the download API. This will return a redirect to the requested content. This method is supported for Caption/Translation and File items.

Parameters

Automatic Translator Assignment

The automatic translator assignment API allows you to assign work to reputable translation resources. To have this feature enable on your Dotsub account please contact your account manager.

The settings that define a reputable user can be found under 'Project Settings' → 'Auto Assign Settings'. There are two types of configuration 'Simple' and 'Advanced'. Simple configuration takes into account both translations and revisions, advanced configuration allows you to configure these independently.

Simple Auto Assign Configuration

The field 'Required Items' denotes how many completed items a use must have to be considered reputable. 'Maximum Items' allow you to set a limit on the number of uncompleted items a user has.

Advanced Auto Assign Configuration

The field 'Translations Required' denotes how many completed translations a use must have to be considered reputable. 'Maximum Translations' allow you to set a limit on the number of uncompleted translations a user has. The field 'Revisions Required' denotes how many completed revisions a use must have to be considered reputable. 'Maximum Revisions' allow you to set a limit on the number of uncompleted revisions a user has.

Assignment API

Path: https://dotsub.com/api/media/$UUID/autoAssign

Method: GET

Example Response

{
  "status": {
    "message": "User successfully assigned",
    "error": false,
    "code": 200
  }
}

Un-Assignment API

Path: https://dotsub.com/api/media/$UUID/unassign

Method: GET

A user can be un-assigned to a language/role only if the current media workflow status is set to "ASSIGNED".

Example Response

{
  "status": {
    "message": "User successfully unassigned",
    "error": false,
    "code": 200
  }
}

Translation Offers

Translation offers allow you to have users volunteer to complete translations. These offers appear in the project dashboard under 'Translation Offers'. Videos must me public to use this API. Public but not 'publicly listed' listed videos can also use this API.

This API allows you to construct a URL to volunteer for a translation or revision. When a user access this URL, they will be asked to log into Dotsub. If you do not include a redirect location they will be shown a thankyou page on Dotsub. If you do provide a redirect URL the user will be sent to this page on completion.

Translation Offer API

Path: https://dotsub.com/offer/$UUID/$languageCode/$type or https://dotsub.com/offer/user/$externalIdentifier/$languageCode/$type

Method: GET

Media Ping

The media ping request will be sent to the configured URL as a HTTP Post. This contains information on what media and what state change has taken place.

Media Ping Types

Posted Media Fields

Order Ping

The order ping request will be sent to the configured URL as a HTTP Post. This contains information on what order or order item and what state change has taken place.

Order Ping Types

Posted Order Fields

Language

Language information is returned via the Language API and in parts of the Media API. Below is a listing of the fields that can be part of the reply.

Media

Media information is returned via the Media API, Project API and is contained in the Media Ping callbacks. Below is a listing of the fields that can be part of the reply.

Media Language

Media language information is returned via the Media API. It is a nested property of the media object.

Caption

Captions are returned by the captions API. Captions are always returned as a JSON array of caption items.

License

Licenses are returned by the License API and as part of the media object.

Project

Project are returned by the Project API. They are containers that hold a group of media.

Order

Orders are returned by the Order API. These contain information on the content you have ordered from Dotsub.

Order Items

Orders items are returned by the Order API. This is a nested property of the order object.