api.clarify.io API

by clarify.io

Overview

The API to Search and Understand Audio & Video Data.

api.clarify.io is an open data API from clarify.io. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 21 endpoints.

At a glance

Authentication: No auth
HTTPS: Yes
CORS: Unknown
Category: Open Data
Base URL: https://api.clarify.io/
Version: 1.3.7
Endpoints: 21
OpenAPI: Specification ↗
Spec updated: 2019-01-03

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.clarify.io/v1/bundles" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("https://api.clarify.io/v1/bundles", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.clarify.io/v1/bundles",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v1/bundles`	List bundles
POST	`/v1/bundles`	Create a bundle
GET	`/v1/bundles/{bundle_id}`	Get a bundle
PUT	`/v1/bundles/{bundle_id}`	Update a bundle
DELETE	`/v1/bundles/{bundle_id}`	Delete a bundle
GET	`/v1/bundles/{bundle_id}/insights`	Get bundle insights
POST	`/v1/bundles/{bundle_id}/insights`	Request an insight to be run
GET	`/v1/bundles/{bundle_id}/insights/{insight_id}`	Get bundle insight
GET	`/v1/bundles/{bundle_id}/metadata`	Get bundle metadata
PUT	`/v1/bundles/{bundle_id}/metadata`	Update bundle metadata
DELETE	`/v1/bundles/{bundle_id}/metadata`	Delete bundle metadata
GET	`/v1/bundles/{bundle_id}/tracks`	Get bundle tracks
POST	`/v1/bundles/{bundle_id}/tracks`	Add a track for a bundle
PUT	`/v1/bundles/{bundle_id}/tracks`	Update a tracks for a bundle
DELETE	`/v1/bundles/{bundle_id}/tracks`	Delete bundle tracks
GET	`/v1/bundles/{bundle_id}/tracks/{track_id}`	Get bundle track
PUT	`/v1/bundles/{bundle_id}/tracks/{track_id}`	Add media to a track
DELETE	`/v1/bundles/{bundle_id}/tracks/{track_id}`	Delete a bundle track
GET	`/v1/reports/scores`	Generate Group Report <span class="label">beta</span>
GET	`/v1/reports/trends`	Generate Trends Report <span class="label">beta</span>
GET	`/v1/search`	Search bundles