Overview

The Indee Automation API is a set of APIs for various applications at Indee. This is the comprehensive suite of APIs that provide developers programmatic access to the Indee platform.

Indee automation APIs can be classified into the following broad categories:

Ingestion
Processing
Viewing
Account Management

Understanding the Indee Platform

To develop using Indee APIs, we encourage you to read and understand the common concepts and then deep dive into specific area around ingestion, processing, viewing or account management.

Indee Entities

Indee entities introduces you to the various objects at Indee and their hierarchical relationships. Their relationship helps you create the right objects and execute various media processing pipelines at Indee.

A detailed introduction to Indee Entities.

Application Registration

To use the Indee API, the application using the API has to be registered with Indee and a developer key must be obtained. This enables the platform to provide the appropriately scoped API keys for the application.

Related documentation: Application Registration Process.

Authentication

All Indee APIs require authentication. The authentication approach varies by application. This section explains the various types of authentication supported by applications and the associated nuances.

Related documentation: Authentication at Indee

Token Management

Indee's authentication mechanism involves usage of dual tokens with short and long expiry. The client applications are required to manage the storage and renewal of these tokens.

Related documentation: Token management at Indee

Content Ingestion

Content ingestion is the process of uploading your content to Indee for processing. To create watermarked videos using the Indee platform, the media must be ingested to the Indee platform. This process is facilitated through a collection of APIs known as the Ingestion API. Metadata must precede ingestion, and is achieved by creating relevant Indee entities like projects and videos.

Content Processing

Once media has been ingested into the Indee platform, screeners are created. A screener represents an instance of the uploaded media that is created to be shared with a viewer. A screener can be customized with rules such as expiration dates, view limits, and security settings. Additionally, groups of these screeners can be organized logically and presented to viewers.

Audience Management

Content on Indee can be shared with viewers by utilizing screeners, allowing for efficient distribution and access. Viewers can be grouped into audiences within the Indee platform, enabling targeted sharing and management of content. Additionally, specific content can be shared across entire audiences, enhancing control and customization, and enriched with additional metadata to tailor the viewing experience.

Build Viewing App

Screeners can be viewed through Indee viewing apps, providing users with a seamless experience across platforms. Alternatively Indee offers the flexibility to create custom viewing apps using Indee's API, allowing for tailored solutions that meet specific requirements.

Account Management

The Enterprise APIs empower administrators to configure enterprise-level parameters, granting control over critical aspects like access permissions and business rules. Through these APIs, administrators can customize attribute settings within the enterprise account, tailoring the platform to meet specific organizational needs.