api.clarify.io
  1. bundles
api.clarify.io
  • bundles
    • List bundles
      GET
    • Create a bundle
      POST
    • Delete a bundle
      DELETE
    • Get a bundle
      GET
    • Update a bundle
      PUT
    • Get bundle insights
      GET
    • Request an insight to be run
      POST
    • Get bundle insight
      GET
    • Delete bundle metadata
      DELETE
    • Get bundle metadata
      GET
    • Update bundle metadata
      PUT
    • Delete bundle tracks
      DELETE
    • Get bundle tracks
      GET
    • Add a track for a bundle
      POST
    • Update a tracks for a bundle
      PUT
    • Delete a bundle track
      DELETE
    • Get bundle track
      GET
    • Add media to a track
      PUT
  • reports
    • Generate Group Report <span class="label">beta</span>
      GET
    • Generate Trends Report <span class="label">beta</span>
      GET
  • search
    • Search bundles
      GET
  1. bundles

Request an insight to be run

POST
/v1/bundles/{bundle_id}/insights
Request an insight to be run on a bundle. Note that most insights are set to automatically run on all bundles so you commonly won't need to call this endpoint except to request transcripts. To configure which insights are automatically run for an app, visit the Clarify Developer Portal.

Insights that are not configured to autorun can be requested to run on an individual bundle using this endpoint. The following insights can be requested:

transcript_r9 - High-accuracy transcript of the speech in audio media.

Transcripts will produced on the mixed audio of all tracks in the bundle and are charged per minute (rounded up for partial minutes), based on the duration of the longest track. If the request has already been made, this method has no effect other than to return the existing insight.

Transcripts will typically take about 48 hours. When the transcript is ready, an InsightNotification webhook will be POSTed to the bundle notify_url.

For more information see Human Transcripts Quick Start.

captions_r9 - High-accuracy captions of the speech in video media.

Captions will be generated on the first track in the bundle. and are charged per minute (rounded up for partial minutes), based on the duration of the media. See the pricing page. If the request has already been made, this method has no effect other than to return the existing insight.

Captions will typically take about 72 hours. When the captions are ready, an InsightNotification webhook will be POSTed to the bundle notify_url.

For more information see Captions Quick Start.

spoken_keywords - Spoken words of interest found in audio media. Note: Normally spoken_keywords is set to autorun so you do not need to run it explicitly.

spoken_topics - Topics spoken about in the audio media.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.clarify.io//v1/bundles//insights' \
--data-urlencode 'insight='
Response Response Example
200 - Example 1
{}

Request

Path Params
bundle_id
string 
required
id of a bundle
Body Params application/x-www-form-urlencoded
insight
string 
required
name of the insight: transcript_r9, captions_r9, spoken_keywords, spoken_topics, spoken_words

Responses

🟢200OK if the insight already exists
application/json
Body
object {0}
🟢202Accepted if the insight has been requested and is queued for processing
🟠400Bad request
🟠404Not found
🟠409Conflict if tracks have a status of error
Modified at 2022-09-10 16:56:00
Previous
Get bundle insights
Next
Get bundle insight
Built with