Video Upload Documentation

AVU File Upload API

This API will allow users to upload a video file to AVU.

URL

http://upload.uncutvideo.aol.com/api/asset/upload

HTTP Method

POST (multipart-form)

Arguments

devId (required) - developer ID required to access AOL APIs
f (required) - required format of the response. Currently, only ‘xml’ is supported.
a (required) - authentication token returned by the OpenAuth login() call
referer (required) - referer provisioned with OpenAuth for the devId
title (required) - caption to be associated with the asset.
desc (optional) - description to be associated with the asset.
catName (optional) - category to be associated with the asset.
reg (optional) - region to be associated with the asset.
loc (optional) - location to be associated with the asset.
tag (optional) - comma delimited tag(s) to be associated with the asset.
share (optional) - access level for sharing. Possible values are pub (public), pri (private), semi (semi-private). If this parameter is not specified then, by default, the asset will be “public”.
notifyByEmail (optional) - indicate if email should be sent after processing is done. Possible values are yes and no.
locale(optional) - locale of the asset.

'title', 'desc' and 'tag' parameters assume UTF-8 encoding. For possible values of 'catName', 'loc', 'reg' and 'locale' parameters, see below.

This API method is implemented as a POST request of MIME type 'multipart/form-data' (see RFC 2388) which is the same method a web browser uses to perform a HTTP file upload. The 'devId', 'f', 'a' and 'referer' parameters have to be provided both as query string parameters of the request URL and as form parameters in the POST body. The rest of the parameters and the file itself should be passed only as POST form data.

The maximum size of the file that can be uploaded using this API is 100 MB.

For possible values of 'catName', 'loc', 'reg' and 'locale' parameters, see below.

Response Format

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <statusCode>200</statusCode>
  <statusText>Ok</statusText>
<data>
   <assetId>1234<assetId>
</data>
</response>

Error Codes

200 - Success (Ok)
400 - Invalid request
401 - Unauthorized (authentication required)
500 - Generic Server Error

Upload Status API

This API allows users to check the status of their uploaded videos to AVU.

URL

http://uncutvideo.aol.com/api/asset/status

HTTP Method

GET

Arguments

devId (required) - developer Id required to access AOL APIs
f (required) - required format of the response. Currently, only ‘xml’ is supported.
a (required) - authentication token returned by the OpenAuth login call
referer (required) - referer provisioned with OpenAuth for the devId
assetId (required) - ID of the asset you want the processing status of

Response Format

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <statusCode>200</statusCode>
  <statusText>Ok</statusText>
<data>
   <status>1<status>
   <playbackPage>
   <thumbURL>
</data>
</response>

playbackPage and thumbURL values are set only when the status is STATUS_SUCCESS.

Values for Status will be one of the following:

STATUS_FAILURE = -6;
STATUS_FTPUPLOAD_ERROR = -5;
STATUS_THUMBNAILEXTRACT_ERROR = -4;
STATUS_TRANSCODING_ERROR = -3;
STATUS_NFSDOWNLOAD_ERROR = -2;
STATUS_SUCCESS = 0;
STATUS_METADATA_COMPLETE = 1;
STATUS_NFSDOWNLOAD_COMPLETE = 2;
STATUS_TRANSCODING_COMPLETE = 3;
STATUS_THUMBNAILEXTRACT_COMPLETE = 4;
STATUS_FTPUPLOAD_COMPLETE = 5;

Error Codes

200 - Success (Ok)
400 - Invalid request
401 - Unauthorized (authentication required)
500 - Generic Server Error

Possible Category Values

The 'catName' parameter sets the category of the video. Its possible values are:

About Me
Art & Animation
Autos & Vehicles
Comedy
Family
Hobbies
Home & Garden
Music
News
Odd & Absurd
Personals
Pets
Short Movies
Sports
Travel
Video Games
VideoBlog

Possible Location and Region parameters

The location of the video is indicated by the 'loc' (Location) and 'reg' (Region) parameters. Their possible values are (format is Region:Location):

Africa: Algeria
Africa: Angola
Africa: Benin
Africa: Botswana
Africa: Burkina Faso
Africa: Burundi
Africa: Cameroon
Africa: Cape Verde
Africa: Central African Republic
Africa: Chad
Africa: Comoros
Africa: Congo
Africa: "Congo, The Democratic Republic Of The"
Africa: Cote D'Ivoire
Africa: Equatorial Guinea
Africa: Gabon
Africa: Gambia
Africa: Ghana
Africa: Guinea
Africa: Guinea-Bissau
Africa: Kenya
Africa: Lesotho
Africa: Liberia
Africa: Libyan Arab Jamahiriya
Africa: Madagascar
Africa: Malawi
Africa: Mali
Africa: Mauritania
Africa: Mauritius
Africa: Mayotte
Africa: Morocco
Africa: Mozambique
Africa: Namibia
Africa: Niger
Africa: Nigeria
Africa: Reunion
Africa: Rwanda
Africa: Saint Helena
Africa: Sao Tome And Principe
Africa: Senegal
Africa: Seychelles
Africa: Sierra Leone
Africa: Somalia
Africa: South Africa
Africa: Swaziland
Africa: "Tanzania, United Republic Of"
Africa: Togo
Africa: Uganda
Africa: Western Sahara
Africa: Zambia
Africa: Zimbabwe
Africa: Africa
Antarctica: Bouvet Island
Antarctica: French Southern Territories
Antarctica: Heard Island And Mcdonald Islands
Antarctica: Antarctica
Arctic: Arctic
Asia: Bangladesh
Asia: Bhutan
Asia: British Indian Ocean Territory
Asia: Brunei Darussalam
Asia: Cambodia
Asia: China
Asia: French Polynesia
Asia: Guam
Asia: Hong Kong
Asia: India
Asia: Indonesia
Asia: Japan
Asia: Kazakhstan
Asia: Kiribati
Asia: "Korea, Democratic People’s Republic Of"
Asia: "Korea, Republic Of"
Asia: Kyrgyzstan
Asia: Lao People’s Democratic Republic
Asia: Macao
Asia: Malaysia
Asia: Maldives
Asia: Marshall Islands
Asia: "Micronesia, Federated States Of"
Asia: Mongolia
Asia: Myanmar
Asia: Nauru
Asia: Nepal
Asia: New Caledonia
Asia: Niue
Asia: Northern Mariana Islands
Asia: Pakistan
Asia: Palau
Asia: Philippines
Asia: Pitcairn
Asia: Samoa
Asia: Singapore
Asia: Solomon Islands
Asia: Sri Lanka
Asia: "Taiwan, Province Of China"
Asia: Tajikistan
Asia: Thailand
Asia: Timor-Leste
Asia: Tokelau
Asia: Tonga
Asia: Tuvalu
Asia: Vanuatu
Asia: Viet Nam
Asia: Wallis And Futuna
Asia: Asia
Australia: American Samoa
Australia: Christmas Island
Australia: Cocos (Keeling) Islands
Australia: Cook Islands
Australia: Fiji
Australia: New Zealand
Australia: Norfolk Island
Australia: Australia
Central America: Anguilla
Central America: Antigua And Barbuda
Central America: Barbados
Central America: Belize
Central America: Cayman Islands
Central America: Costa Rica
Central America: Cuba
Central America: Dominica
Central America: Dominican Republic
Central America: El Salvador
Central America: Grenada
Central America: Guadeloupe
Central America: Guatemala
Central America: Haiti
Central America: Honduras
Central America: Jamaica
Central America: Martinique
Central America: Montserrat
Central America: Netherlands Antilles
Central America: Nicaragua
Central America: Panama
Central America: Papua New Guinea
Central America: Puerto Rico
Central America: Saint Lucia
Central America: Saint Vincent And The Grenadines
Central America: Turks And Caicos Islands
Central America: United States Minor Outlying Islands
Central America: "Virgin Islands, British"
Central America: "Virgin Islands, U.S."
Central America: Central America
Europe: Åland Islands
Europe: Albania
Europe: Andorra
Europe: Austria
Europe: Belarus
Europe: Belgium
Europe: Bosnia And Herzegovina
Europe: Bulgaria
Europe: Croatia
Europe: Czech Republic
Europe: Denmark
Europe: Estonia
Europe: Faroe Islands
Europe: Finland
Europe: Gibraltar
Europe: Greece
Europe: Greenland
Europe: Guernsey
Europe: Holy See (Vatican City State)
Europe: Hungary
Europe: Iceland
Europe: Ireland
Europe: Isle Of Man
Europe: Jersey
Europe: Latvia
Europe: Liechtenstein
Europe: Lithuania
Europe: Luxembourg
Europe: "Macedonia, The Former Yugoslav Republic Of"
Europe: Malta
Europe: "Moldova, Republic Of"
Europe: Monaco
Europe: Montenegro
Europe: Norway
Europe: Poland
Europe: Portugal
Europe: Romania
Europe: Russian Federation
Europe: San Marino
Europe: Serbia
Europe: Slovakia
Europe: Slovenia
Europe: Svalbard And Jan Mayen
Europe: Switzerland
Europe: Tunisia
Europe: Ukraine
Europe: Europe
Europe: France
Europe: Germany
Europe: Italy
Europe: Netherlands
Europe: Spain
Europe: Sweden
Europe: United Kingdom
Middle East: Afghanistan
Middle East: Armenia
Middle East: Azerbaijan
Middle East: Bahrain
Middle East: Cyprus
Middle East: Djibouti
Middle East: Egypt
Middle East: Eritrea
Middle East: Ethiopia
Middle East: Georgia
Middle East: "Iran, Islamic Republic Of"
Middle East: Iraq
Middle East: Israel
Middle East: Jordan
Middle East: Kuwait
Middle East: Lebanon
Middle East: Oman
Middle East: "Palestinian Territory, Occupied"
Middle East: Qatar
Middle East: Saudi Arabia
Middle East: Sudan
Middle East: Syrian Arab Republic
Middle East: Turkey
Middle East: Turkmenistan
Middle East: United Arab Emirates
Middle East: Uzbekistan
Middle East: Yemen
Middle East: Middle East
North America: Bahamas
North America: Bermuda
North America: Canada
North America: Mexico
North America: Saint Kitts And Nevis
North America: Saint Pierre And Miquelon
North America: North America
South America: Argentina
South America: Aruba
South America: Bolivia
South America: Brazil
South America: Chile
South America: Colombia
South America: Ecuador
South America: Falkland Islands (Malvinas)
South America: French Guiana
South America: Guyana
South America: Paraguay
South America: Peru
South America: South Georgia And The South Sandwich Islands
South America: Suriname
South America: Trinidad And Tobago
South America: Uruguay
South America: Venezuela
South America: South America
South Pacific: South Pacific
US: Alabama
US: Alaska
US: Arizona
US: Arkansas
US: California
US: Colorado
US: Connecticut
US: Delaware
US: Florida
US: Georgia
US: Hawaii
US: Idaho
US: Illinois
US: Indiana
US: Iowa
US: Kansas
US: Kentucky
US: Louisiana
US: Maine
US: Maryland
US: Massachusetts
US: Michigan
US: Minnesota
US: Mississippi
US: Missouri
US: Montana
US: Nebraska
US: Nevada
US: New Hampshire
US: New Jersey
US: New Mexico
US: New York
US: North Carolina
US: North Dakota
US: Ohio
US: Oklahoma
US: Oregon
US: Pennsylvania
US: Rhode Island
US: South Carolina
US: South Dakota
US: Tennessee
US: Texas
US: Utah
US: Vermont
US: Virginia
US: Washington
US: Washington D.C.
US: West Virginia
US: Wisconsin
US: Wyoming

'loc' and 'reg' parameters Currently, the following “locale’ values are supported:

de-DE
en-GB
en-US
es-US
es-ES
fr-FR
it-IT
nl-NL
se-SE

More About the AOL Video Upload API

Topic Centers

Other Video Tools

AVU File Upload API

URL

HTTP Method

Arguments

Response Format

Error Codes

Upload Status API

URL

HTTP Method

Arguments

Response Format

Error Codes

Possible Category Values

Possible Location and Region parameters