ElevateAI Postman Collection

Introduction

We’re excited to introduce our Postman collection for ElevateAI, designed to make exploring and integrating our API easier than ever!

This collection is a set of ready-to-use API endpoints that you can access, test, and modify directly in Postman, saving you time and effort during testing and development. Whether you’re testing functionality, learning about API capabilities, or building your application, this collection provides a convenient, user-friendly way to interact with our API.

To use, simply import the collection into Postman, set your API token to the current value for the MyApiToken variable within the Postman Collection Variables, and start making requests. If you do not know your ElevateAI API token, navigate to the Manage Tokens Dashboard to retrieve it.

Get started today and unlock the full potential of ElevateAI!

Download the Collection

Below is the link to download the ElevateAI API Postman Collection. Once downloaded, simply import the Collection into the desired workspace within Postman.

Using the Collection

The first step to use the API, is performing a Declare request. A Declare can be performed either with a download URI for the media to be processed or an anticipation of a subsequent Upload request. There are examples of each in the collection.

Once you have performed the Declare request, add the interactionIdentifier in the response to the Postman Collection Variable MyInteractionId . This will make all subsequent API requests relative to this interaction.

To perform the Upload request, you must first identify the media to be uploaded for processing. This is done under the form-data section of the request Body. Change the Key to be filename.<extension>, where <extension> is the file extension of the file you will be uploaded. Then set the Value to the file you wish to upload.

Once a file has been submitted for processing, either through the dowunloadUri method or the upload method, you must then wait until processing is completed before attempting to get the transcript or AI results for this interaction.

The Status endpoint is used to determine when the processing has been completed.

The only other requests which require specified input are the Ask ElevateAI endpoints. The collection includes 3 examples for this endpoint. Feel free to adjust the questions asked in the Body for any/all of these examples.

Contact us at [email protected] for further assistance.