Product Updates | Contact Support | System Status
Page Contents

    Quick Start: Dynamic Ingest API

    This quick start will help familiarize you with operations available via the Dynamic Ingest API. The Dynamic Ingest API enables you to ingest videos and associated media assets into Video Cloud.

    Rate limiting

    See Best Practices for information on rate limiting.

    Obtain credentials

    Like most of Brightcove's RESTful APIs, the Dynamic Ingest API requires OAuth access tokens to authorize requests. In order to get access tokens, you first need to obtain client credentials with permissions for kinds of operations you want to request. This quick start makes API requests on a Brightcove Learning Services sample account, so you will not need to obtain credentials here, but you should understand what's happening. The CodePen sends the API request information to a proxy similar to this one. The proxy accesses client credentials from a private location and uses them to generate a temporary access token using the OAuth API and then makes the API request and returns the response data.

    To try requests on your own account, get your client credentials and use one of our API testing tools

    1. To obtain your credentials follow the instructions in Managing API Credentials. This is the recommended way of obtaining your client credentials. Remember that using Dyanamic Ingest requires making one CMS API POST request as well, so in addition to ingest permission, you need at least video/write permissions:
      Required Permissions
      Required Permissions

      Use the Studio Admin Tools to get client credentials. You can also obtain credentials using the OAuth API, following the instructions in one of the guides listed below.


    Use the Result tab of CodePen below to test various Dynamic Ingest API requests and see what the request and the response data look like.

    See the Pen Dynamic Ingest API Tester - Dynamic Delivery by Brightcove Learning Services (@rcrooks1969) on CodePen.

    Page last updated on 31 Jan 2021