Clips API

This API helps you retrieve predefined or custom clips of the meeting.

Overview
Meeting Clips/Conversation Clips are short-form video/audio that summarises a particular aspect of the conversation.
Types
Clip Type
Description
Action Items Clips
a short-form audio/video summarizing all the action items of the conversation
Q&A Clips
a short-form audio/video summarizing all the questions and their corresponding responses in the conversation
Conversation Highlights 
a short-form audio/video summarizing all the highlights of the conversation
Custom Clip
a short-form audio/video summarizing instances with custom keywords and keyphrases given as input
post
Compute Metadata
https://api.marsview.ai/v1/conversation/clips/compute
Settings object can be used to enable/disable metadata from different models. Check the overview section for getting a list of models that are available
Request
Response
Request
Headers
appSecret
required
string
<sample-app-secret>
appId
required
string
<sample-app-Id>
Content-Type
optional
string
application/json
Body Parameters
clips.custom
optional
string
List of keywords based on which a custom clip will be generated.
clips.conversation
optional
string
Conversation clips will be generated when clips.conversation is set to true under settings object
clips.qa
optional
boolean
Q&A clips will be generated  when clips.qa key is set to true under the settings object
clips.action_items
optional
boolean
Action item clips will be computed when clips.action_items key is set to true under the settings object
Response
200: OK
A Transaction ID is returned in the JSON body once the processing job is launched successfully.
This Transaction ID can be used to check the status of the job or fetch the results of the job once the metadata is computed
{
    "status":true,
    "transaction_id":32dcef1a-5724-4df8-a4a5-fb43c047716b,
    "message": " Compute job for file-id: 32dcef1a-5724-4df8-a4a5-fb43c047716b launched successfully"
}
400: Bad Request
This usually happens when the settings for computing the metadata are not configured correctly. Check the request object and also the dependencies required to compute certain metadata objects. ( For Example: Speech to Text has to be enabled for Action Items to be enabled).
This can also happen when the input file_id is not of the supported format as shown in the example below.
{
    "status":false,
    "error":{
        "code":"VDNF01",
        "message":"FileTypeError: Require file to be of type Video"
    }
}
Example API Call
Request
CURL
CURL
curl --request POST 'https://api.marsview.ai/v1/conversation/clips/compute' \
--header 'appSecret: 32dcef1a-5724-4df8-a4a5-fb43c047716b' \
--header 'appId: 1ZrKT0tTv7rVWX-qNAKLc' \
--header 'Content-Type: application/json' \
--data-raw '{
                "settings":{
                      "clips":{
                            "qa":true,
                            "conversation":true,
                            "custom":["Marsview" , "Notes Platform", "Nvidia"]
                      }  
                 }
          }'
Response
Given below is a sample response JSON when the Status code is 200.
{
    "status":true,
    "transaction_id":32dcef1a-5724-4df8-a4a5-fb43c047716b,
    "message": " Compute job for file-id: 32dcef1a-5724-4df8-a4a5-fb43c047716b launched successfully"
}
post
Request Metadata
https://api.marsview.ai/v1/conversation/clips/fetch
This method is used to fetch specific Metadata for a particular file_id. It can also be used for long polling to track the progress of compute under the status object.
Request
Response
Request
Headers
Content-Type
optional
string
application/json
appId
optional
string
<sample-app-id>
appSecret
optional
string
<sample-app-secret>
Body Parameters
data.action_items
optional
string
Returns action_items Clips URL for gile_id once computed.
fileID
optional
string
fileId of the audio/video file
data.qa
optional
boolean
Returns screengrabs Clips URL for file_id once computed
Response
200: OK
The output consists of two objects. The data object returns the requested metadata if it is computed. The status object shows the current state of the requested metadata. Status for each metadata field can take values  "Queued"/"Processing"/"Completed".
Shown below is a case where "qa clips" Job is in "Queued" state and "Completed" state. 
QUEUED STATE
COMPLETED STATE
QUEUED STATE
{
    "status":{
        "qa":"Queued",
        "action_items":"Queued"
    }
    "data":{
    }
}
COMPLETED STATE
{
    "status":{
        "qa":"Completed",
        "action_items":"Completed"
    }
    "data":{
        "qa":{
           "presigned_url":"https://s3.aws.com/marsviewClipsBucket/12380/12.mp4?expires=1611146749"         
        },
        "action_items":{
           "presigned_url":"https://s3.aws.com/marsviewClipsBucket/12380/13.mp4?expires=1611146749"         
        },
    }
}
Response Object Fields
Fields
Description
presigned_url
A URL to the Clips MP4 file that is requested. The Url is valid for 15 minutes since the time of request.
​

Conversation API (Bundle) - Previous

Search API

Next - Text API (Bundle)

Topics

Last updated 3 months ago

Clip Type	Description
Action Items Clips	a short-form audio/video summarizing all the action items of the conversation
Q&A Clips	a short-form audio/video summarizing all the questions and their corresponding responses in the conversation
Conversation Highlights	a short-form audio/video summarizing all the highlights of the conversation
Custom Clip	a short-form audio/video summarizing instances with custom keywords and keyphrases given as input

Fields	Description
`presigned_url`	A URL to the Clips MP4 file that is requested. The Url is valid for 15 minutes since the time of request.

Clips API

Overview

Types

postCompute Metadata

Example API Call

Request

Response

postRequest Metadata

Response Object Fields

post
Compute Metadata

post
Request Metadata