Clarify

api.clarify.io

The API to Search and Understand Audio & Video Data.

Data & analytics#openapi#search

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The API to Search and Understand Audio & Video Data.

Endpoints 21

bundles

  • GETList bundles/v1/bundles?limit=1&embed=string&iterator=stringGets the list of bundles. Links to each item are in the _links with link relation <b>items</b>.<br/><br/>After getting the initial list, use the <b>first</b>,…
  • POSTCreate a bundle/v1/bundlesCreate a new bundle with the specified name, media url, and optional JSON metadata.<br/><br/><b>name</b> can be any string you wish to associate with the…
  • GETGet a bundle/v1/bundles/:bundle_id?embed=stringGet a bundle that has previously been created.
  • PUTUpdate a bundle/v1/bundles/:bundle_idUpdate a bundle. To update the tracks, media, or metadata of a bundle, use the tracks and metadata endpoints.<br/><br/><b>name</b> can be any string you wish…
  • DELETEDelete a bundle/v1/bundles/:bundle_idDelete a bundle and its related metadata and tracks. This will only delete media stored on Clarify systems and not delete the source media on remote…
  • GETGet bundle insights/v1/bundles/:bundle_id/insightsGets the insights for a bundle.<br/><br/>URLs of the available insights for the bundle are in the _links object, with the link relations (keys) of the format…
  • POSTRequest an insight to be run/v1/bundles/:bundle_id/insightsRequest an insight to be run on a bundle. Note that most insights are set to automatically run on all bundles so you commonly won&apos;t need to call this…
  • GETGet bundle insight/v1/bundles/:bundle_id/insights/:insight_idGets a particular insight for a bundle. Typically, you will hit this endpoint from a link contained in a response to…
  • GETGet bundle metadata/v1/bundles/:bundle_id/metadataGets the metadata for a bundle.
  • PUTUpdate bundle metadata/v1/bundles/:bundle_id/metadataUpdate the metadata for a bundle.<br/><br/>The metadata is a single-level JSON object of your own definition, containing key-values that can be searched and…
  • DELETEDelete bundle metadata/v1/bundles/:bundle_id/metadataDelete the metadata of a bundle and set data to {} (empty object.) This is functionally equivalent to an update metadata request with data set to…
  • GETGet bundle tracks/v1/bundles/:bundle_id/tracksGets the array of tracks for a bundle. This includes the specification of the media and the status of fetching and processing it.<br/><br/>Media for tracks is…
  • PUTUpdate a tracks for a bundle/v1/bundles/:bundle_id/tracksUpdate tracks for a bundle.<br/><br/><b>parts_complete</b> a boolean <code>true</code> or <cade>false</code>. If true, any tracks in the PENDING state will be…
  • POSTAdd a track for a bundle/v1/bundles/:bundle_id/tracksAdd a new track to a bundle. This will insert or append a new track in the tracks array or return an error if the maximum number of tracks (12) has been…
  • DELETEDelete bundle tracks/v1/bundles/:bundle_id/tracksDelete tracks of a bundle. This will only delete media stored on Clarify systems and not delete the source media on remote systems.<br/><br/>Successful…
  • GETGet bundle track/v1/bundles/:bundle_id/tracks/:track_idGets a single track in a bundle. This includes the specification of the media and the status of fetching and processing it.<br/><br/>Media for a track is…
  • PUTAdd media to a track/v1/bundles/:bundle_id/tracks/:track_idAdd media to an existing track of a bundle. This can only be called on a track that currently has no media set or has parts pending.<br/><br/>Once all media…
  • DELETEDelete a bundle track/v1/bundles/:bundle_id/tracks/:track_idDelete a track of a bundle. This will only delete media stored on Clarify systems and not delete the source media on remote systems.<br/><br/>Successful…

reports

  • GETGenerate Group Report <span class="label">beta</span>/v1/reports/scores?interval=year&score_field=string&group_field=string&filter=string&language=enAnalyzes bundle content over a series of time periods grouped by the value of <b>group_field</b> metadata field and generates a report of top…
  • GETGenerate Trends Report <span class="label">beta</span>/v1/reports/trends?interval=year&content=string&filter=string&language=enAnalyzes bundle content over a series of time periods and generates a trend report.<br/><br/><b>interval</b> specifies the duration of each time period in the…

search

  • GETSearch bundles/v1/search?query=string&query_fields=string&filter=string&language=en&limit=1&embed=string&iterator=stringSearches the bundles and returns a list of matching bundles, along with what matched and where for each bundle.<br/><br/><b>query</b> is used to search for…

API details

Base URL
https://api.clarify.io
Authentication
None declared in the description
Operations
21 operations on 10 pathsGET 10PUT 4DELETE 4POST 3
Main resources
bundles 18reports 2search 1
Description format
Swagger 2.0, API version 1.3.7
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the api.clarify.io in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the api.clarify.io collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List bundles” (GET /v1/bundles?limit=1&embed=string&iterator=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the api.clarify.io?

The API to Search and Understand Audio & Video Data. It is listed under Data & analytics and has 21 endpoints.

Who publishes the api.clarify.io?

It is listed from Clarify's public API description (an OpenAPI document), not published by Clarify on Swastik Codes. Anyone who controls clarify.io can claim the profile by adding a DNS TXT record.

What is the base URL of the api.clarify.io?

Requests go to https://api.clarify.io. Endpoint paths are added to this base URL.

How do I authenticate with the api.clarify.io?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the api.clarify.io have?

21 operations on 10 paths (10 GET, 4 PUT, 4 DELETE, 3 POST). The largest groups are bundles, reports, search.

Is forking the api.clarify.io free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.