POST
/
v2
/
sign-requests
/
video-translation
{}
This endpoint is for files smaller than 30mb for any other files please use the multipart upload endpoint. This endpoint currently supports the following upload types:
  • Video (mp4 / mov)
  • Audio (mp3)
  • Text (pdf)
The API requires a body within the form data. The body needs to be a string in the following format: 
{
   "email": string required,
   "firstName": string required,
   "lastName": string required,
   "companyName": string optional,
   "uploadSettings":{
      "backgroundColor": string optional,
      "language": string optional(defaults to BSL),
      "overlaySize": string,
      "videoDuration": integer
   }
}
The upload settings block is used to provide additional context around your translation request. If company name is not provided a user is made within the system based off the first and last name. For enterprise customers it is recommended that a company name is always provided to avoid the chance of a translation being lost.

​
QuickSplit

QuickSplit is a feature that allows a PDF document to be split by ID. PDF documents are split between the IDs provided the QuickSplit service will take the contents between ID 1 and ID 2 and generate a video from that specific content. This feature is ideal for educational or medical organisations who have large documents that need to be split into multiple consumable formats. To activate QuickSplit you need to provide a .pdf document and set the pdfSplittingIdsarray with the IDs in your document 
{
   "email":"test@email.com",
   "firstName":"Test",
   "lastName":"User",
   "companyName":"Signapse",
   "uploadSettings":{
      "backgroundColor":"#0000",
      "language":"BSL",
      "overlaySize":"M",
      "videoDuration":1
   },
   "pdfSplittingIds":[
      "ABC123",
      "DEF456",
      "GHI789",
   ]
}

Query Parameters

​
draft
boolean | null

Body

multipart/form-data
​
body
string | null
​
video
file | null
​
subtitle
file | null
​
audio
file | null
​
text
file | null

Response

200 - application/json

createVideoTranslation 200 response

The response is of type object.