Getting started with Voicesense API
Welcome to Voicesense API, home of our advanced audio analysis system. Explore the possibilities of our robust APIs, seamlessly integrating powerful audio analysis capabilities into your applications.
Enjoy a seamless authentication experience with our user-friendly Voicesense API. Additionally, we offer the flexibility to authorize your requests using a dedicated API key upon request. This ensures secure and convenient access to our system, tailored to your unique requirements.
With Voicesense APIs, analyzing your audio files has never been easier. Whether you choose to upload the files directly through our dedicated API or provide the file URIs, our system excels at gracefully handling any encountered errors during processing, delivering accurate and reliable results.
To provide you with comprehensive insights, we offer API endpoints specifically designed for monitoring your usage. These endpoints empower you to track and manage your API usage effortlessly, keeping you informed about your resource consumption and enabling data-driven decisions.
Retrieve the analysis results by making API requests using the unique stream ID (GUID) assigned during the upload process. Alternatively, effortlessly configure a webhook with a customizable URL and body, enabling automatic result delivery that seamlessly integrates with your existing systems.
Experience the full potential of our Voicesense audio analysis system and leverage our tailored solutions to gain valuable insights from your audio files. Streamline your workflows, uncover meaningful information, and effortlessly monitor your API usage using our reliable and scalable APIs.
Postman Collection
The following Postman Collection Voisense Postman Collection can be imported with the latest Postman client. It shows the usage of all available endpoints.
Curl
The following commands can be executed in the command line. They show the basic flow: authorization, upload and results retrieval.
Get Authorization Token
First, you need to acquire Bearer Token. It is needed to authorize the other requests.
Replace the username and the password with your credentials.
curl -H "Content-Type: application/x-www-form-urlencoded" --data-urlencode grant_type=password --data-urlencode scope=Porcupine --data-urlencode client_id=Porcupine --data-urlencode client_secret=NNc7DQZqvZ6CRxxI33c7 --data-urlencode username={username} --data-urlencode password={password} https://apim.voicesense.com/auth/connect/token
In response you will get the token in access_token field.
Send the file for processing
Use the access_token you got in the previous request and choose the audio file_path. You can also change ReferenceId – it will be later used to retrieve results. Only remember – it must be unique.
All details of the description field are described in the Audio Upload section of this documentation.
curl -H "Authorization: Bearer {access_token}" -F audio=@"{file_path}" -F description="{\"ReferenceId\":\"{reference_id}\",\"Channels\":[{\"UserId\":\"{user_id}\",\"UserType\":1,\"ChannelType\":1}]}" https://apim.voicesense.com/analysis/audio/process
In response you will get the id representing the uploaded file analysis.
Retrieve results
There are two ways to get the results, either by id
curl -H "Authorization: Bearer {access_token}" https://apim.voicesense.com/analysis/impression/stream/{id}/dashboard
or by referenceId
curl -H "Authorization: Bearer {access_token}" https://apim.voicesense.com/analysis/impression/reference/{referenceId}/dashboard
In response you will get the scores together with metadata.