Solution Builder API
Deep Linking - Workflows
DeepLinking - Advanced
7 min
screenpal's deeplinking ( workflow ) functionality can be extended for more complex use cases involving json based project setup and customized upload workflows ingesting via json workflows in addition to the standard editvideo https // pattern (where https // points to an mp4 ), advanced ingesting supports the format editvideo json https // where https // points to a json endpoint returning a full project specification example json { "title" "title of video project", "description" "optional default description for this project" "video" { "url" "https // ", "type" "mp4" }, "captions" \[ { "id" "your caption id", "title" "your caption title", "type" "vtt", "url" "https // " } ] } field requirements title – required title to assign the video project video url – required direct link to a video file mime type must be video/mp4 video type – optional defaults to h264 mp4 also supports webm and h264 mov description optional if provided will be used as the default value for the description in the upload data for the project captions – optional array of caption tracks id unique id for each caption title string shown to the user in caption list for them to edit the captions type must be either vtt or srt url url to download the caption file uploading with advanced metadata screenpal's editor uploads by making a post request to basicupload request url , passing title description extended parameters captionlanguageids – comma separated list of caption ids used in the editor either provided from the initial workflow launch or created by the user in the app any captions created within the app will have id based on language selected e g your caption id,en us,jp jp response handling if the server responds with a single line of text, it will be treated as the direct video upload url (legacy behavior) to support advanced uploading, respond with content type application/json and use the following format { "video" { "url" "https // " }, "captions" \[ { "id" "your caption id", "type" "vtt", "url" "https // " }, { "id" "en us", "type" "vtt", "url" "https // " } ] } upload response requirements video url – required url to put / post the mp4 file captions – optional urls to upload captions based on the captionlanguageids in the first post request type – optional "vtt" or "srt" defaults to "vtt" if omitted