---
title: ElevateAI Postman Collection
slug: tutorials/elevateai-postman-collection
description: Learn how to access ElevateAI, an AI-powered platform that offers eight different endpoints for generating and retrieving insights. Start by creating a free account to receive an API token for authentication and usage tracking. Explore the platform's Inte
docTags: 
createdAt: 2022-06-21T20:32:15.000Z
---

# <font color="#3694fc">//  </font>Introduction

We’re excited to introduce our Postman Collection for NiCE ElevateAI, designed to make exploring and integrating our API easier than ever!&#x20;

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.&#x20;

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 [Manage Tokens Dashboard](https://docs.elevateai.com/tutorials/elevateai-dashboards#_xQWv) to retrieve it.&#x20;

[Get Started Today](docId\:MCxT9ad7ZH7V59fXPy_7I) – and unlock the full potential of ElevateAI!&#x20;

# <font color="#3694fc">//  </font>Download the Collection

Follow this link to fork the ElevateAI Postman Collection into your desired Postman workspace: Access the [ElevateAI Postman Collection](https://www.postman.com/elevateai-api-team/elevateai-by-nice-public-api-workspace/collection/yeygata/elevateai-api-collection)&#x20;

If you prefer Postman-generated API documentation, our [ElevateAI API Postman Documentation](https://documenter.getpostman.com/view/27905620/2sAYJ99dLt) can be [accessed here](https://documenter.getpostman.com/view/27905620/2sAYJ99dLt).

The Postman documentation makes understanding and trying the API very easy. &#x20;

**NOTE:&#x20;**&#x54;he [ElevateAI Documentation files](docId\:lFWjv5nFkVOvdur_eu_ie) should be considered the definitive ElevateAI reference, as they include options and parameters for every endpoint.

# <font color="#3694fc">//  </font>Using the Collection

The first step in using the API is performing a [`Declare request`](docId:9mNs6MzkIGF7fXtfy5FIJ). &#x20;

A Declare request can be performed either with a download URI for the media to be processed or in anticipation of a subsequent [Upload request](docId\:U1WeFr_6X15M5IauoOA7t).  There are examples of each in the collection.

Once you have performed the [Declare request](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.&#x20;

To perform the [Upload request](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`**&#x6D;ethod 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 [Ask ElevateAI Q\&A](docId:4JbLvbXQcii7uM6Vr1NzH)<font color="#3694fc"> </font>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 [ElevateAI Support team](mailto\:support@elevateai.com). &#x20;
