Skip to main content
Platform API Overview
Updated over a week ago

Platform APis comprise the main APIs that allow programmatic control of the most powerful aspects of the AnyClip Platform - Video Processing and Analysis.

They also allow management of the main AnyClip Platform entities - users, hubs, and playlists.

The current section provides summaries of the preceding API categories followed by links to the full API documentation.

It allows developers to test AnyClip Platform APIs and to see the relevant API documentation.

Prerequisite: Setting up an API account

Contact your AnyClip Customer Success Manager to obtain your initial tokens. You will receive a pair of access and refresh tokens. Here is an example:

{
"access": "eyJhbGciOiJIUzI1NiJ9.eyJydWxlIjpbIl4oLispOlxcL3YxXFwvaHVicyhcXD8uKnxcXC8uKiR8KSJdLCJjbyI6IjEzNTMxNiIsInUiOiI4OTk5MSIsImFjIjoiNDM2NCIsImV4cCI6MTcxNTMzNTg1MCwiZWQiOjE3NDYwNDY4MDAwMDB9.jGlxegzHaEZRsPdltPme90k4wWdethVkIGy-bUI7qak",
"refresh": "eyJhbGciOiJIUzI1NiJ9.eyJydWxlIjpbIl4oLispOlxcL3YxXFwvaHVicyhcXD8uKnxcXC8uKiR8KSJdLCJjbyI6IjEzNTMxNiIsInUiOiI4OTk5MSIsImFjIjoiNDM2NCIsImV4cCI6MTc0NjA0NjgwMCwiZWQiOjE3NDYwNDY4MDAwMDB9.1bgzIvIUSYUOOQm6iJ0UjtSI2A6wKhBW_ROZCwXZ6Rs"
}

The access token grants access to most AnyClip Gateway endpoints. It is valid for 10 days from the time of generation and expires thereafter.

Remember to replace the access token with a new one upon expiration or in advance (see Tokens expiration section below).

Tokens expiration

If the access token expires (AnyClip Gateway returns "JWT token is expired" error), it becomes invalid for use in AnyClip Gateway and must be replaced with a new one.

To obtain a new pair of access and refresh tokens, use the AnyClip Gateway endpoint here (for the US-based access point), passing the refresh token as a parameter.

Note

Compared to the access token, the refresh token expiration date remains constant upon regeneration. It usually expires a year after it is provided first, but sometimes it can be issued for shorter periods.

If the refresh token expires, contact your AnyClip Customer Success Manager to obtain a new one.

Video Processing and Analysis APIs

AnyClip provides the world's first visual intelligence engine to automatically tag, analyze, filter out non-brand-safe content, and categorize each video according to keywords, official Interactive Advertising Bureau (IAB) categories, sentiments, celebrities, brands, and more.

AnyClip’s video intelligence technology powers a stand-alone Software as a Service (SaaS) solution for businesses, publishers, and advertisers who own video content and are seeking to elevate their business through insightful content intelligence. Consuming and acting upon your video intelligence can be done via the SaaS platform (UI), as well as via a broad set of APIs.

Users APIs

The Create and Update User API allows customers to create and update AnyClip users directly in the AnyClip platform. Updating a user in the system can be implemented using email or ID. Other useful User APIs are:

  • GET Sources - the list of the user's* account-specific sources

  • GET Timeszone - list of all timezones available on the Platform

  • Get Hubs - list of the user's* account-specific hubs.

* The user whose token is used.

Note

A single error is enough to prevent a new user record from being created in the database. Furthermore, a newly created user will be created with the status "Enabled".

Playlist APIs

The Playlist APIs allow companies to get, create, and update video playlists programmatically.

Hubs APIs

The Hubs APIs allow companies to get, create, and update account hubs programmatically.

Watches APIs

The Watches APIs allow companies to get videos of their watch channels programmatically.

Versions APIs

The Version APIs allow companies to upload new video versions.

Caution

The endpoints of all APIs described above are limited to 10000 records.

Access Points

AnyClip provides two access points to its Gateway APIs:

Did this answer your question?