Uploads

Upload a video for conversion

Upload one video at a time and get a video id back. The video id is used to connect a video with a document or template. We accept files up to 120 MB and recommend compressing videos before uploading to save bandwidth. All uploaded videos are automatically downsized to 720p and compressed using the mpeg4 H.264 codec. We recommend uploading the video file as a multipart/form-data post to minimize transfer time.

Use video_id to assign the video to a document, template or reminder, and job_id to poll Retrieve video job status.

A video can be used as an introduction to a document, or sent as a video reminder.

post/v1/upload/video

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/upload/video
  • Auth: HTTP bearer

Request body

file_namestring

Filename of the video, with the extension, for example intro.mp4. Required with file_content: without it the video is created with an empty title and never gets a playable URL. With a multipart file or file_url it defaults to the uploaded file name or the last segment of the URL.

file_urlstring

Url to the video file. The file must be available for download without any authorization. It is always downloaded over https://, also when the URL starts with http://.

file_contentstring

Send the video file as base64 encoded. Make multiple requests to upload multiple files. Note that base64 encoding files will increase the file size by about 30%

filestring binary

Response

The request succeeded.

statusnumber required

Legacy success indicator, always 1 in a successful response.

idstring required

Id of the created video, the same value as video_id.

file_idstring required

Legacy file id generated for the response, which does not reference the stored video.

filenamestring required

Name the video was uploaded with, taken from file_name, the multipart file name or the last segment of file_url.

job_idstring required

Id to poll the video job status with, the same value as video_id.

video_idstring required

Id of the uploaded video, used to assign it to a document, template or reminder.

file_statusstring required

Status of the uploaded file, always file.uploaded in a successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.