Skip to main content
The Postman collection brings together the endpoints consumable by API key, already organized by domain, with the same groups as the API reference, ready for you to test with your API key. It uses the conventions described in Authentication: authentication by Bearer token and base https://api.nuvia.ai. The collection is generated from the same specification that powers the Reference, so both show exactly the same surface.

​
Download the collection

Download Postman collection (.zip)

A .zip file with the collection in Postman v2.1 format. Unzip it to get nuvia-postman-collection.json.
The download is a .zip. Unzip it before importing. Inside is a single file, nuvia-postman-collection.json, which is the collection itself.

​
Import into Postman

1

Unzip the file

Extract the downloaded .zip. You’ll get the nuvia-postman-collection.json file.
2

Import into Postman

In Postman, click Import (top-left corner) and select nuvia-postman-collection.json. The Nuvia API collection appears in the sidebar, with endpoints grouped by domain: Agents, Contacts, Conversations, Messages, Inboxes, Campaigns, Campaign Enrollments, Tables and Lists, Knowledge Base, and Webhooks.
3

Configure the variables

The collection uses two variables. Open the Nuvia API collection, go to the Variables tab, and fill in:Save. See how to generate a key in the API key guide.
4

Make your first call

Choose any read request (for example, list agents) and click Send. Authentication is already configured in the collection. Each request inherits the Bearer token with your NUVIA_API_KEY.

​
How authentication is configured

The collection defines authentication at the collection level: the type is Bearer token and the token is the {{NUVIA_API_KEY}} variable. All requests inherit this configuration, so you don’t need to fill in the Authorization header on each one: just set the NUVIA_API_KEY variable once.
The collection covers only what an API key can call. The platform’s login flow and key management (/v1/api-keys) require the user token and are left out. See the API key guide to create and revoke keys.
Some requests have the x-company-id header disabled. It’s only needed for internal-use global API keys; with a company key, leave it as is.
NUVIA_API_KEY is a sensitive credential. Don’t share the collection with the variable’s value filled in, and prefer using a Postman environment variable instead of saving the value directly in the collection.

​
Next steps

Authentication

How to authenticate your calls with an API key.

Integration examples

Complete use cases with cURL, JavaScript, and Python.