previous page |next page

create¶

Create a new video by sending metadata and requestion an upload URL.

Parameters¶

title (optional) : string: Title of the video.

tags (optional) : string: Tags for the video. Multiple tags should be comma-separated.

description (optional) : string: Description of the video.

author (optional) : string: Author of the video.

date (optional) : signed integer: Video creation date. Date must be an UTC date in Unix timestamp format.

link (optional) : string: The URL of the web page where this video is published.

custom.param (optional) : string

User defined parameter. param part of the request parameters (after the ‘.’ separator) specifies name of the parameter. Parameter name should adhere to the following naming rules:

name can contain letters, numbers and punctuation characters ‘.’, ‘_’, ‘-‘
name cannot start with a number or punctuation character
name cannot contain spaces

User defined parameter can be specified multiple times, as far as parameter name is unique.

md5 (optional) : string: Video file MD5 message digest. If supplied, it will be checked by the API.

size (optional) : unsigned integer: Video file size. If supplied, it will be checked by the API.

Warning

The maximum allowed video file size is 5 GiB.

Example response¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <video key="vtQmcboj">
    <link>
      <protocol>http</protocol>
      <address>upload.bitsontherun.com</address>
      <path>/v1/videos/upload</path>
      <query>
        <key>vtQmcboj</key>
        <token>e2bbad0fd889d5d2e30047596cfe3789778257d2</token>
      </query>
    </link>
  </video>
</response>

Response parameters¶

/response/status : string: Call execution status. Set to ok if call executed successfully.

//video/@key : string: Key of the created video.

//video/link/protocol : string: Protocol part of the upload URL.

//video/link/address : string: Address part of the upload URL.

//video/link/path : string: Path part of the upload URL.

//video/link/query/key : string: Upload key query parameter.

//video/link/query/token : string: Upload token query parameter.

Upload¶

The parameters in the link block can subsequently be used to construct an upload URL and submit the file to it.

previous page | Reference Overview |next page