Developer

Quickstart:

The Quickstart API enables the creation of Animoto video projects with content provided by partner websites and applications.

Developers can specify the image, video, and audio assets to be included in Animoto projects via a single HTTP GET or POST. Users sent to Animoto are automatically prompted to create a free Animoto account (if not already a member) and guided in creating a video with the pre-seeded partner assets.

With the Quickstart API, partners can:

  • Send users to Animoto to create a new video.
  • Specify images, video clips, and an audio track to be included in the new video.
Terms of Service

By using the Animoto Quickstart Reference Code, you agree to the following Terms of Service:

  • Animoto's Quickstart™ API allows Quickstart User to populate certain music or image/video content for its users. Quickstart User warrants that this content is in compliance with Animoto's Site Terms of Service, has been properly licensed by Quickstart User, and won't require payment to third parties by Animoto.
  • Quickstart User agrees to indemnify Animoto for any claim, liability or expense relating to the populated content, and Quickstart User's use of the Quickstart API.
  • The Quickstart API is provided 'AS IS', and Animoto disclaims all warranties relating to the Quickstart API, including without limitation the implied warranties of merchantability and fitness for purpose.
  • All use of the Quickstart API is subject to Animoto's Site Terms of Service.
Prerequisite Checklist

Maximize success of a Quickstart deployment by ensuring the following prerequisites are considered:

  • An Animoto affiliate code is required to use Quickstart.
    • Sign in to view your Quickstart Reference Code.
  • All pre-seeded images, video clips, and audio tracks must be available online via a publicly accessible URL. If a browser cannot open an asset URL, the Quickstart API cannot either.
  • Supported image formats:
    • jpg, jpeg, gif, tif, tiff, png.
  • Supported video formats:
    • mp4, avi, mov, qt, 3gp, m4v, mpg, mpeg, mp4v, h264, wmv, mpg4, movie, m4u, flv, dv, mkv, mjpeg, ogv, mts, mvi, m2ts.
  • Supported audio formats:
    • mp3.
Usage and Parameters

All links and form POSTs to Quickstart should be directed to: http://animoto.com/api/quickstart.

Parameters may be specified as individual fields within a POST body or as query string arguments on a GET request. The following table enumerates the supported parameters.

Parameter Required? Description
assets[] Optional Specifies the image and video clips to use in the new video project. Passed as an array of string URLs. See prerequisites above for supported file formats. Each member must be a fully qualified URL including filename extension (e.g. ".jpg").
audio Optional Specifies the audio track to use in the new video project. See prerequisites for supported file formats. Must be a fully qualified URL including filename extension (e.g. ".mp3").
ref Required The affiliate code to be associated with the Quickstart user. Sign in to see your Quickstart Reference Code.
welcome_name Optional New users will be greeted with a custom welcome message with your name in it. For example, if you specified 'My Company', they would see 'Welcome to Animoto, My Company user! '
Considerations using HTTP GET

When using HTTP GET as the communication method, one must consider two important items: URL length limitations and URL escape encoding.

URLs are limited to 2,083 characters from within many popular browsers (see technote). Specifying a large number of assets or having very long public URLs referencing pictures/audio in the Quickstart GET link may go over the 2,083 character boundary and unexpectedly trim the URL. It is recommended that partners use HTTP POST in these situations.

Additionally, URLs used as parameters must be properly URL encoded with escape characters. You can use the URL encoding utility here to correctly encode your asset and audio URLs for GET links.






Examples  

Login Required
Please sign in to view your Quickstart Reference Code and to see the examples.

Quickstart Buttons and Logos

Depending on your needs, you may want to present an Animoto Quickstart button to your users. Its a great way of visually promoting your Quickstart integration.

Just choose a graphic to suit your needs, and insert it into your Quickstart code.

Downloads

Dimensions URL
Animoto Quickstart 170 x 25 Download
Animoto Quickstart 170 x 25 Download
Animoto Quickstart 170 x 25 Download
Animoto Quickstart 25 x 25 Download
Animoto Quickstart 25 x 25 Download

Examples

Login Required
Please sign in to view your Quickstart Reference Code and to see the examples.