Using Postman to test Speech & Conversation Analytics APIs
Overview
The Speech Analytics API Bundle provides a REST API interface to accurately transcribe your meetings, phone calls, and other offline meeting recordings and extract speech and conversation insights using Marsview's proprietary AI and NLP models.
Using Postman to test Speech & Conversation Analytics APIs
For easy testing using Postman, we provided a Postman Collection for Marsview Speech Analytics APIs. This is a simple 6 step tutorial to quickly test out the Marsview Speech & Conversation Analytics APIs.
The files are available here:
After downloading Postman and Marsview's Postman Collection. You canFile > import
the collection into Postman to get started.
Step 1: Get your API Key and Secret
Get your API Key and API Secret by registering to Marsview as a developer.
If you are having trouble registering please contact hello@marsview.ai to get your API Key and Secret.
Your API Key and Secret will be in the following format
"apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
"apiSecret": "xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx"
Step 2: Generate your Access Token
Set a New Environment on Postman as shown below, this will ensure all the variables that will be set in further steps in the process are correctly assigned.
Set Postman workspace variables
Click on the More > Edit
Under the Variables
tab set userID
,apiKey
and apiSecret
as Workspace variables on Postman as shown below.
Generate Access Token
Using the API [POST] Get token
API you will be able to generate anaccessToken
that will expire in 1 hour from the time of token generation. You will be able to upload an audio/video file or a file URL using this accessToken
Instruction: Click on[POST]
Get token
and click onSend
Step 3: Get Transaction ID by submitting an Audio/Video file
You can upload an Audio/Video File using [POST] Upload file
or use [POST] Upload file url
(Recommended) to submit/upload a file URL.
Instruction: Fill in the file details such astitle
,description
, link
(URL) and click on Send
You can this as a sample meeting recording URL: https://d1sv72xa22bi8g.cloudfront.net/api-samples/Recruitment+Meeting.mp4
This will generate a Transaction ID or txnId
which is a unique ID generated for a particular file or URL submitted to Marsview.
Step 4: Submit txnID
for processing
txnID
for processingEach AI model/API (mentioned in the Overview section) can be configured to get the most accurate results for your use case. To know more about the configurations go to Speech & Conversation API Overview.
Instruction: For ease of testing, we have preconfigured all the API to default configuration values so all you have to do is go to [POST] Upload request
and hit Send
If you have questions on configuration or additional feature request please feel free to contact our developers at hello@marsview.ai
You will see an output JSON as shown below with the status "uploaded"
Step 5: Get Request Status
NOTE: The processing might take a few minutes depending on the time duration of the file uploaded. Example: If a file is 10 min long the process will be completed in 3-5 min.
[GET] Request Status
is used to get the status of the file being processed. The status will go from "uploaded"
to "processing"
to "completed"
. If there's an error transcribing your file, the status will go to "error"
and there will be an "err"
and"msg"
key in the response JSON which will contain more information.
Tip: You can use [GET] Request Status per process
to get the status of each AI model separately as well.
Step 6: Get Metadata
Once the Request Status is set to "completed"
, you'll see a full JSON response with your transcription text, like this by sending a request to the [GET] Metadata
API.
Instruction: Click on[GET]Metadata
and click onSend
Tip: You can use [GET] metadata Status per process
to get the metadata of each AI model separately as well.
Contact Support
Our support team is available to respond to user requests via email at support@marsview.ai.
1st Response SLA is less than 24 hours.
Users must reach us by filling out the support form available here with their Full Name, Email Address and a brief description of the problem.
A support engineer shall respond with 2 hours with a support case number.
You can also Book a Call with our engineers.
Last updated