Pricing | Blog | API | FAQ
 
 
Vidly API Basics
API Interface
Vidly accepts XML requests sent on http://m.vid.ly/api/ URL via simple HTTP POST (please note, you should keep trailing slash in URL).
XML should be placed in xml POST parameter.
In response Vidly sends XML as well.
You can try it right away on the API test page: http://m.vid.ly/test/test_api.php.
XML Request Anatomy
All XML requests are expected to be like this: 
	<?xml version="1.0"?>
<Query>
	<Action>[Action]</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<!-- ...Action specific contents follows... -->
</Query>
Param Description
(required)
Action
 Action to perform. See List of allowed actions below
(required)
UserID
 Vidly User ID
(required)
UserKey
 Vidly API Key used for user authentication
(optional)
Notify
 Valid URL or Email to send notification when request is processed.
In case when URL is provided, Vidly will POST XML response data on this URL. In case of AddMedia, additional XML will be sent, notifying that video has been converted.
XML Response Anatomy
Vidly XML responses share following common structure: 
	<?xml version="1.0"?>
<Response>
	<Message>[Message]</Message>
	<MessageCode>[MessageCode]</MessageCode>
	<Success>
		<!-- ...Content specific to Action... -->
	</Success>
	<Errors>
		<!-- ...Content specific to Action... -->
	</Errors>
</Response>
Param Description
Message
 Summary of request processing result
MessageCode
 See descriptions of codes in Action sections
Success
 Container for Action-specific values, for example short URLs generated by AddMedia
Errors
 Container for Action-specific Errors
Common response codes:
1.1 - Action failed: wrong query info.
1.2 - Action failed because of some internal reason.
1.3 - Action failed because request rate over limit.
List of API Actions
Each Action has own set of specific params, each is described in separate section with examples:
 
 
AddMedia
Description
Add a new media to user's queue. Creates new short URL and generates 24 various output formats. Also allows to specify user defined custom formats.
Request Example
<?xml version="1.0"?>
<Query>
	<Action>AddMedia</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<Source>
		<SourceFile>[SourceFile1]</SourceFile>
		<CDN>[CDNType]</CDN>	</Source>
	<!-- ... -->
	<Source>
		<SourceFile>[SourceFile2]</SourceFile>
		<CDN>[CDNType]</CDN>
	</Source>
	<!-- ... -->
	<Source>
		<SourceFile>[SourceFileN]</SourceFile>
		<CDN>[CDNType]</CDN>
		<Format>
			<!-- ...click for details... -->
		</Format>
		<Format>
			<FormatID>[ID]</FormatID>
		</Format>
	</Source>
</Query>
Request Params
Param Description Default Value
(required)
Source
 Complex param containing SourceFile, CDN and Format values. None
(required)
SourceFile 		Media source file. Following sources are supported:
  • http://[user[:password]@]hostname[:port]/[path]/[filename]
  • ftp://[user[:password]@]hostname[:port]/[path]/[filename]
  • sftp://[user[:password]@]hostname[:port]/[path]/[filename]
  • http://[AWS_KEY:AWS_SECRET@][bucket].s3.amazonaws.com/[filename]
    • If you need your S3 files to be accessed with your own AWS credentials, add your AWS key/secret to the URL. [Note: do not forget to encode your AWS_SECRET, specifically replace / with %2F. If you don't specify AWS key/secret, the object must have READ permission for AWS user 1a85ad8fea02b4d948b962948f69972a72da6bed800a7e9ca7d0b43dc61d5869 (or for all users). See Amazon S3 guide for details.
  • http://RS_USER:RS_KEY@storage.cloudfiles.com/your_folder/file.ext
  • https://storage4.clouddrive.com/v1/MossoCloudFS_cea19775-aa94-4d78-8da9-1a7b4bbbd548/your_folder/file.ext?auth-token=c2633419-7b79-3d58-8417-d63666dddfd5
Multiple files from different sources (HTTP, FTP, etc) may be specified. If multiple files provided, they will be concatenated before converting. 		None
(optional)
CDN 		CDN service that will be used for upload. Allowed values:
  • RS - Rackspace Cloudfiles
  • AWS - Amazon S3
 AWS
(optional)
Format 		Any additional format to convert video to.
There may be more than one additional format. Note that most formats are provided automatically, so use it in some special cases.
Your formats will get names in the form: [Output]_[number of custom format: 0, 1 etc.].[Output].
See detailed description in Format Parameter Contents section. 		None
Response Example
<?xml version="1.0"?>
<Response>
	<Message>[Success]</Message>
	<MessageCode>[MessageCode]</MessageCode>
	<Success>
		<MediaShortLink>
			<SourceFile>[SourceFile1]</SourceFile>
			<ShortLink>[MediaShortLink1]</ShortLink>
		</MediaShortLink>
		<MediaShortLink>
			<SourceFile>[SourceFile2]</SourceFile>
			<ShortLink>[MediaShortLink2]</ShortLink>
		</MediaShortLink>
		<!-- ... -->
		<MediaShortLink>
			<SourceFile>[SourceFileN]</SourceFile><!-- Source file of added media -->
			<ShortLink>[MediaShortLinkN]</ShortLink><!-- Short link of added media -->
		</MediaShortLink>
	</Success>
	<Errors><!-- if file is not in Success section, it must be in this one -->
		<Error><!-- Relates to the appropriate SourceFile in the request list -->
			<SourceFile>[SourceFileK]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionK]</Description>
			<Suggestion>[ErrorSuggestionK]</Suggestion>
		</Error>
		<!-- ... -->
		<Error>
			<SourceFile>[SourceFileL]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionL]</Description>
			<Suggestion>[ErrorSuggestionL]</Suggestion>
		</Error>
	</Errors>
</Response>
Response Fields
Param Description
MediaShortLink
SourceFile Contents of SourceFile param in request
ShortLink Generated short link for provided media
Error
SourceFile Initial source file for this short link
ErrorCode Error code, see below
Description Error description
Suggestion Helpful advice to avoid error, or detailed error description
Error Codes
2.1 - You have not provided any source links in your request or all source links are invalid.
2.2 - Provided source file link is wrong.
2.3 - An Output tag was not provided or more than one Output tag is given.
2.5 - Short URL can not be secured with selected CDN
2.6 - Invalid security params
2.7 - Vanity Link already exists
Response Codes
2.1 - All medias have been added.
2.2 - Action completed with errors: some files failed to upload.
2.3 - Action failed: none of files were uploaded.
2.4 - Action failed: none of media short link were found.
2.5 - All medias have been updated.
Notify XML Response #2
After Media is converted to all formats, Vidly sends another XML on Notify URL or Email:
<?xml version="1.0"?>
<Response>
	<Result>
		<Task>
			<UserID>[UserID]</UserID>
			<MediaShortLink>[MediaShortLink]</MediaShortLink>
			<SourceFile>[SourceFile]</SourceFile>
			<BatchID>[BatchID]</BatchID>
			<Status>[Status]</Status>
			<Created>[LinkCreatedDate]</Created>
			<Updated>[LinkUpdatedDate]</Updated>
			<UserEmail>[UserEmail]</UserEmail>
			<Formats>
				<Format>
					<FormatName>[FormatName1]</FormatName>
					<Location>[Location1]</Location>
					<FileSize>[FileSize1]</FileSize>
					<Status>[Status1]</Status>
				</Format>
				<Format>
					<FormatName>[FormatName2]</FormatName>
					<Location>[Location2]</Location>
					<FileSize>[FileSize2]</FileSize>
					<Status>[Status2]</Status>
				</Format>
				<!-- ... -->
				<Format>
					<FormatName>[FormatNameN]</FormatName>
					<Location>[LocationN]</Location>
					<FileSize>[FileSizeN]</FileSize>
					<Status>[StatusN]</Status>
				</Format>
			</Formats>
		</Task>
	</Result>
</Response>

 
 
AddMediaLite
Description
Add a new media to user's queue. Creates new short URL and generates only 5 output formats. This API call is designed for customers who do not want to incur the ongoing storage expense of all 24 of our standard web and mobile output formats and are less concerned with complete mobile device coverage. Also allows to specify user defined custom formats.
Request Example
<?xml version="1.0"?>
<Query>
	<Action>AddMedia</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<Source>
		<SourceFile>[SourceFile1]</SourceFile>
		<CDN>[CDNType]</CDN>
	</Source>
	<Source>
		<SourceFile>[SourceFile2]</SourceFile>
		<CDN>[CDNType]</CDN>
	</Source>
	<!-- ... -->
	<Source>
		<SourceFile>[SourceFileN]</SourceFile>
		<CDN>[CDNType]</CDN>
		<Format>
			<!-- ...click for details... -->
		</Format>
		<!-- ... -->
		<Format>
			<!-- ...click for details... -->
		</Format>
	</Source>
</Query>
Request Params
Param Description Default Value
(required)
Source
 Complex param containing SourceFile, CDN and Format values. None
(required)
SourceFile 		Media source file. Following sources are supported:
  • http://[user[:password]@]hostname[:port]/[path]/[filename]
  • ftp://[user[:password]@]hostname[:port]/[path]/[filename]
  • sftp://[user[:password]@]hostname[:port]/[path]/[filename]
  • http://[AWS_KEY:AWS_SECRET@][bucket].s3.amazonaws.com/[filename]
    • If you need your S3 files to be accessed with your own AWS credentials, add your AWS key/secret to the URL. [Note: do not forget to encode your AWS_SECRET, specifically replace / with %2F. If you don't specify AWS key/secret, the object must have READ permission for AWS user 1a85ad8fea02b4d948b962948f69972a72da6bed800a7e9ca7d0b43dc61d5869 (or for all users). See Amazon S3 guide for details.
  • http://RS_USER:RS_KEY@storage.cloudfiles.com/your_folder/file.ext
  • https://storage4.clouddrive.com/v1/MossoCloudFS_cea19775-aa94-4d78-8da9-1a7b4bbbd548/your_folder/file.ext?auth-token=c2633419-7b79-3d58-8417-d63666dddfd5
Multiple files from different sources (HTTP, FTP, etc) may be specified. If multiple files provided, they will be concatenated before converting. 		None
(optional)
CDN 		CDN service that will be used for upload. Allowed values:
  • RS - Rackspace Cloudfiles
  • AWS - Amazon S3
 AWS
(optional)
Format 		Any additional format to convert video to.
There may be more than one additional format. Note that most formats are provided automatically, so use it in some special cases.
Your formats will get names in the form: [Output]_[number of custom format: 0, 1 etc.].[Output].
See detailed description in Format Parameter Contents section. 		None
Response Example
<?xml version="1.0"?>
<Response>
	<Message>[Success]</Message>
	<MessageCode>[MessageCode]</MessageCode>
	<Success>
		<MediaShortLink>
			<SourceFile>[SourceFile1]</SourceFile>
			<ShortLink>[MediaShortLink1]</ShortLink>
		</MediaShortLink>
		<MediaShortLink>
			<SourceFile>[SourceFile2]</SourceFile>
			<ShortLink>[MediaShortLink2]</ShortLink>
		</MediaShortLink>
		<!-- ... -->
		<MediaShortLink>
			<SourceFile>[SourceFileN]</SourceFile><!-- Source file of added media -->
			<ShortLink>[MediaShortLinkN]</ShortLink><!-- Short link of added media -->
		</MediaShortLink>
	</Success>
	<Errors><!-- if file is not in Success section, it must be in this one -->
		<Error><!-- Relates to the appropriate SourceFile in the request list -->
			<SourceFile>[SourceFileK]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionK]</Description>
			<Suggestion>[ErrorSuggestionK]</Suggestion>
		</Error>
		<!-- ... -->
		<Error>
			<SourceFile>[SourceFileL]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionL]</Description>
			<Suggestion>[ErrorSuggestionL]</Suggestion>
		</Error>
	</Errors>
</Response>
Response Fields
Param Description
MediaShortLink
SourceFile Contents of SourceFile param in request
ShortLink Generated short link for provided media
Error
SourceFile Initial source file for this short link
ErrorCode Error code, see below
Description Error description
Suggestion Helpful advice to avoid error, or detailed error description
Error Codes
2.1 - You have not provided any source links in your request or all source links are invalid.
2.2 - Provided source file link is wrong.
2.3 - An Output tag was not provided or more than one Output tag is given.
Response Codes
2.1 - All medias have been added.
2.2 - Action completed with errors: some files failed to upload.
2.3 - Action failed: none of files were uploaded.
2.4 - Action failed: none of media short link were found.
2.5 - All medias have been updated.

 
 
UpdateMedia
Description
Allows to update an existing Vid.ly URL with new source content. Very simple! Via API you can use the UpdateMedia call along with the shortlink and you're ready to roll.
Request Example
<?xml version="1.0"?>
<Query>
	<Action>UpdateMedia</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<Source>
		<MediaShortLink>[MediaShortLink]</MediaShortLink>
		<SourceFile>[SourceFile1]</SourceFile>
		<CDN>[CDNType]</CDN>
	</Source>
	<!-- ... -->
	<Source>
		<MediaShortLink>[MediaShortLink]</MediaShortLink>
		<SourceFile>[SourceFileN]</SourceFile>
		<CDN>[CDNType]</CDN>
		<Format>
			<!-- ...click for details... -->
		</Format>
		<!-- ... -->
		<Format>
			<!-- ...click for details... -->
		</Format>
	</Source>
</Query>
Request Params
Param Description Default Value
(required)
Source
 Complex param containing MediaShortLink, SourceFile, CDN and Format values. None
(required)
MediaShortLink 		Short link of Media to update None
(required)
SourceFile 		Media source file. Following sources are supported:
  • http://[user[:password]@]hostname[:port]/[path]/[filename]
  • ftp://[user[:password]@]hostname[:port]/[path]/[filename]
  • sftp://[user[:password]@]hostname[:port]/[path]/[filename]
  • http://[AWS_KEY:AWS_SECRET@][bucket].s3.amazonaws.com/[filename]
    • If you need your S3 files to be accessed with your own AWS credentials, add your AWS key/secret to the URL. [Note: do not forget to encode your AWS_SECRET, specifically replace / with %2F. If you don't specify AWS key/secret, the object must have READ permission for AWS user 1a85ad8fea02b4d948b962948f69972a72da6bed800a7e9ca7d0b43dc61d5869 (or for all users). See Amazon S3 guide for details.
  • http://RS_USER:RS_KEY@storage.cloudfiles.com/your_folder/file.ext
  • https://storage4.clouddrive.com/v1/MossoCloudFS_cea19775-aa94-4d78-8da9-1a7b4bbbd548/your_folder/file.ext?auth-token=c2633419-7b79-3d58-8417-d63666dddfd5
Multiple files from different sources (HTTP, FTP, etc) may be specified. If multiple files provided, they will be concatenated before converting. 		None
(optional)
CDN 		CDN service that will be used for upload. Allowed values:
  • RS - Rackspace Cloudfiles
  • AWS - Amazon S3
 AWS
(optional)
Format 		Any additional format to convert video to.
There may be more than one additional format. Note that most formats are provided automatically, so use it in some special cases.
Your formats will get names in the form: [Output]_[number of custom format: 0, 1 etc.].[Output].
See detailed description in Format Parameter Contents section. 		None
(optional)
VanityLink 		Set alternate nice-looking short URL for your media
(optional)
Protect 		Optional parameters to specify Media URL access restrictions None
(optional)
StartDate 		Short URL will be available only starting from this date. Date format is "YYYY-MM-DD HH:MM:SS" (time part is optional), date should be in EST time zone None
(optional)
ExpirationDate 		Short URL will be available only until this date. Date format is "YYYY-MM-DD HH:MM:SS" (time part is optional), date should be in EST time zone None
(optional)
IpAddress 		IP Address mask(s). Examples:
  • 192.168.1.50 - just a single IP
  • 192.168.1.1-50 - IP range from 192.168.1.1 to 192.168.1.50
  • 192.168.1.* - IP range from .0 to .255
  • 192.168.1-10.* - even bigger IP range
  • 192.168.2.*,192.168.3.1-50,192.168.4.100 - several masks combined, separated with comma
 None
(optional)
Token 		Make Short URL accessible only with security token None
Response Example
<?xml version="1.0"?>
<Response>
	<Message>[All medias have been updated.]</Message>
	<MessageCode>[MessageCode]</MessageCode>
	<BatchID>[BatchID]</BatchID>
	<Success>
		<MediaShortLink>
			<SourceFile>[SourceFile]</SourceFile>
			<ShortLink>[ShortLink]</ShortLink>
		</MediaShortLink>
		<MediaShortLink>
			<SourceFile>[SourceFile2]</SourceFile>
			<ShortLink>[ShortLink2]</ShortLink>
		</MediaShortLink>
		<!-- ... -->
	</Success>
	<Errors> <!-- if file is not in Success section, it must be in this one -->
		<Error> <!-- Relates to the appropriate SourceFile in the request list -->
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<ErrorName>[ErrorName]</ErrorName>
			<Description>[ErrorDescriptionK]</Description>
			<Suggestion>[ErrorSuggestionK]</Suggestion>
		</Error>
		<!-- ... -->
		<Error>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<ErrorName>[ErrorName]</ErrorName>
			<Description>[ErrorDescriptionK]</Description>
			<Suggestion>[ErrorSuggestionK]</Suggestion>
		</Error>
	</Errors>
</Response>
Response Fields
Param Description
MediaShortLink
SourceFile Contents of SourceFile param in request
ShortLink Short link for updated media
Error
SourceFile Initial source file for this short link
ErrorCode Error code, see below
Description Error description
Suggestion Helpful advice to avoid error, or detailed error description
Error Codes
6.1 - You have not provided any media short link in your request or medias short link are invalid.
6.2 - The medias short url you provided is not belongs to provided user.
6.3 - Provided media short link is't in Finished or Error status.
2.5 - Short URL can not be secured with selected CDN
2.6 - Invalid security params
2.7 - Vanity Link already exists
Response Codes
2.1 - All medias have been added.
2.2 - Action completed with errors: some files failed to upload.
2.3 - Action failed: none of files were uploaded.
2.4 - Action failed: none of media short link were found.
2.5 - All medias have been updated.

 
 
DeleteMedia
Description
Removes uploaded videos by short URL or by BatchID.
Request Example
<?xml version="1.0"?>
<Query>
	<Action>DeleteMedia</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<MediaShortLink>[MediaShortLink1]</MediaShortLink>
	<MediaShortLink>[MediaShortLink2]</MediaShortLink>
	<!-- ... -->
	<MediaShortLink>[MediaShortLinkN]</MediaShortLink>
	<!-- or -->
	<BatchID>[BatchID]</BatchID>
</Query>
Request Params
Param Description Default Value
MediaShortLink
 Short link to the media you have uploaded None
BatchID
 ID of some batch for accessing all files included to this batch.
Note: if you specify batch ID in query request, all stand-alone media short links in this request will be ignored 		None
Response Example
<?xml version="1.0"?>
<Response>
	<Message>[Success]</Message>
	<MessageCode>[MessageCode]</MessageCode>
	<Success>
		<MediaShortLink>[MediaShortLink1]</MediaShortLink>
		<MediaShortLink>[MediaShortLink2]</MediaShortLink>
		<!-- ... -->
		<MediaShortLink>[MediaShortLinkN]</MediaShortLink>
	</Success>
	<Errors><!-- if file is not in Success section, it must be in this one -->
		<Error><!-- Relates to the appropriate SourceFile in the request list -->
			<SourceFile>[SourceFileK]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionK]</Description>
			<Suggestion>[ErrorSuggestionK]</Suggestion>
		</Error>
		<!-- ... -->
		<Error>
			<SourceFile>[SourceFileL]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionL]</Description>
			<Suggestion>[ErrorSuggestionL]</Suggestion>
		</Error>
	</Errors>
</Response>
Response Fields
Param Description
MediaShortLink
 Short URL that has been successfully removed
Error
SourceFile Initial source file for this short link
ErrorCode Error code, see below
Description Error description
Suggestion Helpful advice to avoid error, or detailed error description
Error Codes
3.1 - You have not provided any media short links in your request or all media short links are invalid.
3.2 - Provided media short link is wrong.
3.3 - Batch ID you provided is not correct or does not exist.
3.4 - There are no media short links associated with this batch.
3.5 - You are not allowed to delete this media because it was not uploaded by you.
3.6 - We have tried to delete this media short link, but it was not deleted properly.
3.7 - The media short link you have requested has been already deleted.
Response Codes
3.1 - All medias have been deleted.
3.2 - Action completed with errors: some media short links are wrong.
3.3 - Action failed: all media short links are wrong.
3.4 - Action failed: batch ID is wrong.
3.5 - Action failed: batch is empty.
3.6 - Action completed with errors: some media short links were not deleted properly.

 
 
GetStatus
Description
Can be used to obtain status information on jobs, by BatchID or MediaShortlink
Request Example
<?xml version="1.0"?>
<Query>
	<Action>GetStatus</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<MediaShortLink>[MediaShortLink1]</MediaShortLink>
	<MediaShortLink>[MediaShortLink2]</MediaShortLink>
	<!-- ... -->
	<MediaShortLink>[MediaShortLinkN]</MediaShortLink>
	<!-- or -->
	<BatchID>[BatchID]</BatchID>
</Query>
Request Params
Param Description Default Value
MediaShortLink
 Short link to the media you have uploaded None
BatchID
 ID of some batch for accessing all files included to this batch.
Note: if you specify batch ID in query request, all stand-alone media short links in this request will be ignored 		None
Response Example
<?xml version="1.0"?>
<Response>
	<Message>[Success]</Message>
	<MessageCode>[MessageCode]</MessageCode>
	<Success>
		<Task>
			<UserID>[UserID]</UserID>
			<MediaShortLink>[MediaShortLink]</MediaShortLink>
			<SourceFile>[SourceFile]</SourceFile>
			<BatchID>[BatchID]</BatchID>
			<Status>[Status]</Status>
			<Created>[LinkCreatedDate]</Created>
			<Updated>[LinkUpdatedDate]</Updated>
			<UserEmail>[UserEmail]</UserEmail>
		</Task>
		<!-- ... -->
		<Task>
			<!-- ... -->
		</Task>
	</Success>
	<Errors> <!-- if file is not in Success section, it must be in this one -->
		<Error> <!-- Relates to the appropriate SourceFile in the request list -->
			<SourceFile>[SourceFileK]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionK]</Description>
			<Suggestion>[ErrorSuggestionK]</Suggestion>
		</Error>
		<!-- ... -->
		<Error>
			<SourceFile>[SourceFileL]</SourceFile>
			<ErrorCode>[ErrorCodeID]</ErrorCode>
			<Description>[ErrorDescriptionL]</Description>
			<Suggestion>[ErrorSuggestionL]</Suggestion>
		</Error>
	</Errors>
</Response>
Response Fields
Param Description
Task
UserID ID of the user that uploaded this media. Presently this is the same user that sent the GetStatus query but it may change in future versions of API
MediaShortLink Short link of this media
SourceFile Initial source file for this short link
BatchID ID of the batch this short link is included in
Status Upload status of the short link. It may be one of the following:
"New", "Processing", "Error", "Finished"
Created date and time of short link creation
Updated Date and time of short link last update
UserEmail ID of the user that uploaded this media. Presently this is the same user that sent the GetStatus query but it may change in future versions of API
Error
SourceFile Initial source file for this short link
ErrorCode Error code, see below
Description Error description
Suggestion Helpful advice to avoid error, or detailed error description
Error Codes
4.1 - You have not provided any media short links in your request or all media short links are invalid.
4.2 - Provided media short link is wrong.
4.3 - Batch ID you provided is not correct or does not exist.
4.4 - There are no media short links associated with this batch.
4.5 - You are not allowed to get status of this media because it was not uploaded by you.
4.6 - Some error occurred at uploading this media, so this link is nonoperating.
4.7 - The media short link you have requested was deleted.
Response Codes
4.1 - Action successful.
4.2 - Action completed with errors: some media short links are wrong.
4.3 - Action failed: all media short links are wrong.
4.4 - Action failed: batch ID is wrong.
4.5 - Action failed: batch is empty.

 
 
GetStatistics
Description
Get browser and mobile devices visits statistics for specified time range and short URL. If short URL is not specified, will return cumulative stats for all your videos
Request Example
<?xml version="1.0"?>
<Query>
	<Action>GetStatistics</Action>
	<UserID>[User ID]</UserID>
	<UserKey>[User key]</UserKey>
	<Notify>[Notify URL]</Notify>
	<Filter>
		<StartDate>2012-01-01 00:00:00</StartDate>
		<EndDate>2012-01-30 23:59:59</EndDate>
		<MediaShortLink>[MediaShortLink]</MediaShortLink> <!-- Optional -->
	</Filter>
</Query>
Request Params
Param Description Default Value
(optional)
Filter
 Optional parameters to specify time frame or Media URL None
(optional)
StartDate 		Start date of statistics time frame
(optional)
EndDate 		Final date of statistics time frame
(optional)
MediaShortLink 		Short link to the media you have uploaded None
Response Example
<?xml version="1.0"?>
<Response>
<Message>[Success]</Message>
<MessageCode>[MessageCode]</MessageCode>
<Success>
	<StatsInfo>
		<StatsTable>
			<cols>
				<col>Class</col>
				<col>Vendor</col>
				<col>Model</col>
				<col>Platform</col>
				<col>OS</col>
				<col>Browser</col>
				<col>Browser Ver</col>
				<col>Hits</col>
			</cols>
			<rows>
				<row>
					<col>Desktop</col>
					<col></col>
					<col></col>
					<col></col>
					<col>Windows</col>
					<col>Firefox</col>
					<col>9.0.1</col>
					<col>1</col>
				</row>
				<row>
					<col>Mobile</col>
					<col>Apple</col>
					<col>iPhone</col>
					<col></col>
					<col>iOS</col>
					<col></col>
					<col></col>
					<col>1</col>
				</row>
				<!-- ... -->
			</rows>
		</StatsTable>
		<TotalHits>1</TotalHits>
	</StatsInfo>
</Success>
</Response>
Response Fields
Param Description
StatsInfo
StatsTable Table containing view counts grouped by browsers and mobile devices
TotalHits Number of total views
Error Codes
7.1 - Your account is not authorized to process request.
7.2 - Invalid Filter params.
7.3 - Notify is not applicable for this request.
Response Codes
7.4 - OK
7.5 - Error

 
 
Custom Output Format Parameters (optional)

Use the format parameters to create custom video output profile outside of the standard vid.ly output profiles and device detection. An http link to your custom output profiles will be sent along with the XML response when the job is complete. Bandwidth of custom outputs is metered and billed along with your vid.ly bandwidth each month.
XML Example
<Format>
	<Output>[Output]</Output>
	<Size>[Size]</Size>
	<Bitrate>[Bitrate]</Bitrate>
	<Framerate>[Framerate]</Framerate>
	<VideoCodec>[VideoCodec]</VideoCodec>
	<AudioBitrate>[AudioBitrate]</AudioBitrate>
	<AudioSampleRate>[AudioSampleRate]</AudioSampleRate>
	<AudioCodec>[AudioCodec]</AudioCodec>
	<AudioChannelsNumber>[AudioChannelsNumber]</AudioChannelsNumber>
	<AudioVolume>[AudioVolume]</AudioVolume>
	<TwoPass>[TwoPass]</TwoPass>
	<CBR>[CBR]</CBR>
	<ACBR>[ACBR]</ACBR>
	<Maxrate>[Maxrate]</Maxrate>
	<Minrate>[Minrate]</Minrate>
	<Bufsize>[Bufsize]</Bufsize>
	<Keyframe>[Keyframe]</Keyframe>
	<Start>[Start]</Start>
	<Duration>[Duration]</Duration>
	<RCInitOccupancy>[RCInitOccupancy]</RCInitOccupancy>
	<Deinterlacing>[Deinterlacing]</Deinterlacing>
	<CropTop>[CropTop]</CropTop>
	<CropLeft>[CropLeft]</CropLeft>
	<CropRight>[CropRight]</CropRight>
	<CropBottom>[CropBottom]</CropBottom>
	<KeepAspectRatio>[KeepAspectRatio]</KeepAspectRatio>
	<SetAspectRatio>[SetAspectRatio]</SetAspectRatio>
	<AddMeta>[AddMeta]</AddMeta>
	<Hint>[Hint]</Hint>
	<Rotate>[Rotate]</Rotate>
	<Preset>[Preset]</Preset>
	<Bframes>[Bframes]</Bframes>
	<GOP>[GOP]</GOP>
	<LumaSpatial>[LumaSpatial]</LumaSpatial>
	<ChromaSpatial>[ChromaSpatial]</ChromaSpatial>
	<LumaTemp>[LumaTemp]</LumaTemp>
</Format>

This table describes params inside <Format> tag.
Option Allowed Values Default Values

(required) Output

Format type

 flv, fl9, wmv, 3gp, mp4, m4v, ipod, iphone, ipad, android, ogg, webm, appletv, psp, zune, mp3, wma, m4a, thumbnail, image, mpeg2 (just experimental feature, please use with care, feedback is welcome), iphone_stream, ipad_stream. None.

Size

Video frame size

All: WxH, where W and N are any even integers.
3gp: 128x96, 176x144, 352x288, 704x576, 1408x1152
appletv: 710x480
zune: 320x180, 320x240
vp6: WxH, where W and N are multiple of 16

Custom: To match your source aspect ratio, set X value to zero and Y value to your desired height.  For example, 0x360 or 0x480.

 All: None (any size possible)
3gp: 76x144
iPhone: 480x368
iPad: 1280x720
Android: 800x40
appletv: 710x480
zune: 320x180
psp: 368x192
   Note: You can specify only one dimension: either width or height. In this case, set other dimension to 0. (I.e. 640x0).
Bitrate
Video bitrate		 All: Nk (where N is any non-zero integer) All: 512k
3gp: 256k
iOS, Android, PSP: 1024k
Framerate
Frame rate		 All: any non-zero integer or N/M where N and M are non-zero integers All: none
psp: 30000/1001
VideoCodec
Video codec		 flv: flv, libx264, vp6
fl9: libx264
wmv, zune: wmv2, msmpeg4
3gp, android: h263, mpeg4, libx264
m4v: mpeg4
mp4, ipod, iphone, ipad, appletv, psp: mpeg4, libx264
ogg: libtheora
webm: libvpx
mp3, wma: none
mpeg2: mpeg2video		 flv: flv
fl9, ipod, iphone, ipad: libx264
wmv, zune: wmv2
3gp: h263
mp4, m4v,appletv, psp, android: mpeg4
ogg: libtheora
webm: libvpx
mpeg2: mpeg2video
AudioBitrate
Audio bitrate		 Nk - where N is any non-zero integer
3gp: 4.75k, 5.15k, 5.9k, 6.7k, 7.4k, 7.95k, 10.2k, 12.2k
flv, wmv, mp3, wma, zune: 32k, 40k, 48k, 56k, 64k, 80k, 96k, 112k, 128k, 144k, 160k, 192k, 224k, 256k, 320k
ogg, webm: 45k,64k, 80k, 96k, 112k, 128k, 160k, 192k, 224k, 256k, 320k, 500k		 All: 64k
3gp, android: 12.2k
ipod, iphone, ipad, psp: 128k
AudioSampleRate
Audio sampling frequency (Hz)		 All: any non-zero integer
3gp: 8000
flv, mp3: 11025, 22050, 44100
ogg, webm: 16000, 32000, 44100, 22050, 11025, 192000
wmv, wma, zune: 11025, 22050, 32000, 44100, 48000
mpeg2: 44100, 48000		 All: none
3gp, android: 8000
flv, mp3, zune, mpeg2: 44100
AudioCodec
Audio codec		 mp3: libmp3lame
m4a: libfaac
flv: libmp3lame, libfaac
fl9, mp4, m4v, ipod, iphone, ipad, appletv, psp: libfaac
wmv, wma, zune: wmav2, libmp3lame
ogg, webm: libvorbis
3gp: libamr_nb
android: libamr_nb, libfaac
mpeg2: pcm_s16be, pcm_s16le		 flv, mp3: libmp3lame
fl9, mp4, m4v, ipod, iphone, ipad, appletv, psp: libfaac
wmv, zune: wmav2
ogg, webm: libvorbis
3gp, android: libamr_nb
mpeg2: pcm_s16be
m4a: libfaac
AudioChannelsNumber
Number of audio channels		 All: any non-zero integer
3gp: 1
android: 1, 2		 All: 2
3gp, android: 1
AudioVolume
Audio volume level (%)		 non-negative integer 100
TwoPass
2-pass encoding toggle		 yes, no no
CBR
CBR (Constant bitrate) toggle		 yes, no no
ACBR
CBR (Constant bitrate) for audio stream toggle. Use only with vorbis (Ogg, Webm).		 yes, no no
Maxrate
Maximum allowed video bitrate		 N or Nk - where N is any non-zero integer None
Minrate
Minimum allowed video bitrate		 N or Nk - where N is any non-zero integer None
Bufsize
Rate control buffer size (bits)		 N or Nk - where N is any non-zero integer None
Keyframe 12 [12 PAL DVD] , 15 [15 NTSC DVD], 25 [25 PAL Long GOP], 30 [30 NTSC Long GOP] 15
Start
Start encoding from (sec)		 non-negative integer None
Duration
Duration (sec)		 positive integer None
RCInitOccupancy
Initial rate control buffer occupancy (bits)		 N or Nk - where N is any non-zero integer None
Deinterlacing
De-interlacing toggle		 yes, no no
CropTop
Top crop band size (in pixels)		 even integer None
CropLeft
Left crop band size (in pixels)		 even integer None
CropRight
Right crop band size (in pixels)		 even integer None
CropBottom
Bottom crop band size (in pixels)		 even integer None
KeepAspectRatio
Keep width to height ratio of the original frame size		 yes, no yes

SetAspectRatio

Display aspect ratio (DAR). When set, the option keep_aspect_ratio will be ignored. The option only works with the following formats: fl9, 3gp, mp4, m4v, ipod, iphone, ipad, android, ogg, webm, appletv, psp, iphone_stream, ipad_stream.

 Positive float value or N:M - where N and M are any positive integers. None
AddMeta
Add meta data to the file. Only works with FLV.		 yes, no All: None
flv: no
Hint
Add RTP data (for streaming servers). Only works with MP4.		 yes, no All: None
mp4: no
Rotate
Rotate video picture. Only works with video files.		 def - don't change anything. Video will be rotated according to 'Rotation' meta data parameter, if it exists
0 - don't rotate and ignore 'Rotation' meta data parameter
90 - rotate by 90 degree CW and ignore 'Rotation' meta data parameter
180 - rotate by 180 degree and ignore 'Rotation' meta data parameter
270 - rotate by 270 degree CW and ignore 'Rotation' meta data parameter		 def
Preset
Specify format preset. Only works with WebM.		 1 - 2-Pass Best Quality VBR Encoding
2 - 2-Pass Faster VBR Encoding
3 - 2-Pass VBR Encoding for Smooth Playback on Low-end Hardware
4 - 2-Pass CBR Encoding for Limited-bandwidth Streaming
5 - 2-Pass VBR Encoding for Noisy / Low-quality Input Source
6 - 1-Pass Good Quality VBR Encoding		 6
Bframes 2 [on = IBBPBBP], 0 [off = IPPPPPP] 2
GOP sgop [Strict (Locked)], cgop [Closed (Scene Detection)] cgop

LumaSpatial

Spatial luma strength

 [0,255] 4

ChromaSpatial

Spatial chroma strength

 [0,255] 3

LumaTemp

Temporal luma strength

 [0,255] 6
Talk To Us About Your Video Needs High Volume or Enterprise? Schedule a free 15-minute consultation with our encoding experts.
Tell us who you are

Tell us where to reach you
–


Tell us what time works for you

Tell us your email

Or, call us now at 800.513.1740.