Practice Area: Ingest Profiles API

In this topic, you will learn how to use the Ingest Profiles API to manage ingest and transcode profiles for your account. The practice area will let you try a variety of API request on your own account or a sample Brightcove Account.


The Ingest Profiles API allows you to:

  • Get the profiles for your account

  • Create new profiles

  • Update profiles

  • Delete profiles

  • Set or update the default profile for your account

A Restful API

The Ingest Profiles API is a RESTful API. It accepts HTTPS requests and returns a JSON response.

This means that you can use the API with any language you choose - Ruby, Java, PHP, Python, JavaScript (via AJAX or nodejs), etc. All you have to be able to do is make HTTPS requests and handle a JSON response.

Get credentials

To use the CMS API you will need proper credentials.

The easiest way to get credentials in most cases is through the Studio Admin API Authentication section (requires admin permissions on your account). See Managing API Authentication Credentials for details. In most cases, you probably just want to get permissions for all Ingest Profiles API operation:

Ingest Profiles API Permissions
Ingest Profiles API Permissions

If the permissions you need are not available in Studio, or if you prefer to get them directly from the OAuth API, use your choice of the Get Client Credentials documents listed below. Whichever option you choose, you will need to ask for the correct operation permissions. The following can be used with cURL or Postman to get all permissions for the Ingest Profiles API:

  "operations": [

Quick start app

Find all the code associated with this sample in this GitHub repository.

See the Pen Quick Start: Ingest Profiles API (Dynamic Delivery) by Brightcove Learning Services (@rcrooks1969) on CodePen.

Using the CodePen

Here are some tips to effectively use the above CodePen:

  • Toggle the actual display of the player by clicking the Result button.
  • Click the HTML/CSS/JS buttons to display ONE of the code types.
  • Click Edit on CodePen in the upper right corner to fork this CodePen into your own account.
  • Find all the code associated with this sample in this GitHub repository.

Proxy code

In order to build your own version the sample app on this page, you must create and host your own proxy. (The proxies used by Brightcove Learning Services only accept requests from Brightcove domains.) A sample proxy, very similar to the one we use, but without the checks that block requests from non-Brightcove domains, can be found in this GitHub repository. You will also find basic instructions for using it there, and a more elaborate guide to building apps around the proxy in Using the REST APIs.