ElevateAI Postman Collection
3 min
// // introduction we’re excited to introduce our postman collection for nice 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, visit the https //docs elevateai com/tutorials/elevateai dashboards# xqwv to retrieve it docid\ mcxt9ad7zh7v59fxpy 7i – and unlock the full potential of elevateai! // // download the collection follow this link to fork the elevateai postman collection into your desired postman workspace access the https //www postman com/elevateai api team/elevateai by nice public api workspace/collection/yeygata/elevateai api collection if you prefer postman generated api documentation, our https //documenter getpostman com/view/27905620/2sayj99dlt can be https //documenter getpostman com/view/27905620/2sayj99dlt the postman documentation makes understanding and trying the api very easy note the docid\ lfwjv5nfkvovdur eu ie should be considered the definitive elevateai reference, as they include options and parameters for every endpoint // // using the collection the first step in using the api is performing a declare docid 9mns6mzkigf7fxtfy5fij a declare request can be performed either with a download uri for the media to be processed or in anticipation of a subsequent docid\ u1wefr 6x15m5iauooa7t there are examples of each in the collection once you have performed the docid 9mns6mzkigf7fxtfy5fij , a postman script will 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 docid\ u1wefr 6x15m5iauooa7t , 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 uploading – and then set the value to the file you wish to upload once a file has been submitted for processing – either through the downloaduri method or the upload method – you must wait until processing is complete before attempting to get the transcript or ai results for this interaction the status https //app archbee com/docs/acw 2ietruxveltfplrhn/dg0fhnxsbeeqtyd1ruqrq endpoint is used to determine when the processing has been completed the only other requests which require specified input are the docid 4jblvbxqcii7um6vr1nzh endpoints the collection includes three (3) examples for this endpoint feel free to adjust the questions asked in the body for any/all of these examples need more help? contact the mailto\ support\@elevateai com