Home » API Reference » Encoding Settings » Job » Input

input

:String permalink

API Versions: V1, V2

Valid Values: A valid URL to a media file (HTTP/HTTPS, FTP/FTPS, SFTP, Azure, GCS, CF or S3), with or without authentication

Compatible Job Types: vod

Example:

  • http://example.com/path/to/input.avi
  • sftp://user:pass@example.com/path/to/input.mp3
  • s3://my-bucket/video.mp4
  • cf://username:api_key@container/video.wmv
  • cf+uk://username:api_key@container/video.wmv
  • azure://account-name:account-key@container/video.wmv
  • gcs://access_key:secret_key@gcs-bucket/video.mov
  • aspera://user:pass@host:ssh-port/path/to/file.mp4
  • s3+eu-central-1://my-bucket/video.mp4

Description:

A URL for the file to be transcoded. If the remote server requires authentication, you must include your username and password in the input URL string.

If the URL contains authentication with special characters, make sure that they are properly escaped. Special characters in the path should not need to be escaped.

Notes on S3:

You must grant write permissions to Zencoder on the output bucket before submitting a job to Zencoder. Please note that it is the S3 bucket, and not the S3 "path" which needs write permission. For example, an asset at http://s3.amazonaws.com/my_files/0000/video.mp4 needs write access added to "my_files" (the bucket name), not "my_files/0000" (the path).

To create keys containing special characters that are not valid in URLs (? or #), you must URL encode them (%3F and %23, respectively). All other characters must not be URL encoded.

If the S3 URL has been pre-signed (containing "Signature", "Expires" and "AWSAccessKeyId" query parameters), then all characters must be URL encoded.

You may provide the region of the S3 bucket by setting the URL's protocol to s3+region-name, where "region-name" is defined by this document. For example, to access a file from a bucket in the Asia Pacific (Singapore) region, set the URL to s3+ap-southeast-1://my-bucket/file.mp4.

Notes on Azure:

If the URL contains authentication with special characters, make sure that they are properly escaped.

Notes on Cloud Files:

You can specify the region to use (US or UK) by adding it to the protocol, like cf+uk://username:api_key@container/object. Currently the only Cloud Files regions supported are DFW, ORD and UK. The US region will be used by default.

Any special characters in the container name must be URL encoded.

Notes on Google Cloud Storage:

GCS access keys can be found under the "Interoperable Access" section in the Google APIs console. Access keys must be properly escaped.

Notes on Aspera:

The ssh-port portion of the URL is not required, and will default to 22.

Zencoder runs an Aspera Client on the video encoding servers, which connects to your Aspera Enterprise or Connect Server, which hosts the files.

This is a similar situation to you running an FTP server to make your files available and Zencoder using an FTP client for file transfer.

{
  "input": "http://example.com/path/to/input.avi"
}
      
<api_request>
  <input>http://example.com/path/to/input.avi<&#47;input>
</api_request>