Quickstart: Use the API

This article shows you how to use the Azure AI Video Indexer API. You can't use the API with the trial account.

Prerequisites

  1. Create an Azure AI Video Indexer standard account.
  2. Upload a media file. There are two ways:
    1. Upload a media file to the URL of your choice (recommended). You can use a public network location. After you upload the file, you can check whether the file is accessible to AVI by copying and pasting it into your browser's location bar. If you can play the media file, then it's likely that VI can also access it. If you would like to secure the storage location using Azure Storage Blob, upload the file and obtain a SAS URL. For more information about getting a secure URL for your file, see Azure Blob Storage SAS URLs. This URL is used to copy your file to Azure AI Video Indexer for indexing.
    2. Send the video file a byte array in the request body. For more information about uploading a media file as a byte array in a request body, see Upload a blob with .NET.

Subscribe to the API

  1. Sign in to the Azure AI Video Indexer API developer portal with the account you created.
  2. Find, copy and save the primary and secondary keys. You can find your subscription in your Profile. The primary and secondary keys are in the Subscriptions section.
  3. Select the Show link for both the Primary key and the Secondary key. Copy and paste them to a text editor until you're ready to use them in your environment variables file.

Authorization and samples

For authorization examples specific to your development language, see the Samples.

Try the API in a web browser

You can explore requests with the API using the Try It button in the reference.