> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nuvia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman collection

> Download the official Nuvia API collection and import it into Postman to test the endpoints

The Postman collection brings together the endpoints consumable by API key, already organized by
domain, with the same groups as the [API reference](/en/api-reference), ready for you to test with
your **API key**. It uses the conventions described in [Authentication](/en/autenticacao):
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

<Card title="Download Postman collection (.zip)" icon="download" href="/assets/nuvia-postman-collection.zip">
  A `.zip` file with the collection in Postman v2.1 format. Unzip it to get
  `nuvia-postman-collection.json`.
</Card>

<Note>
  The download is a `.zip`. Unzip it before importing. Inside is a single file,
  `nuvia-postman-collection.json`, which is the collection itself.
</Note>

## Import into Postman

<Steps>
  <Step title="Unzip the file">
    Extract the downloaded `.zip`. You'll get the `nuvia-postman-collection.json` file.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Configure the variables">
    The collection uses two variables. Open the **Nuvia API** collection, go to the
    **Variables** tab, and fill in:

    | Variable        | Value                                      |
    | --------------- | ------------------------------------------ |
    | `baseUrl`       | `https://api.nuvia.ai` (already filled in) |
    | `NUVIA_API_KEY` | your API key                               |

    Save. See how to generate a key in the [API key guide](/en/guia-api-key).
  </Step>

  <Step title="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`.
  </Step>
</Steps>

## 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.

<Note>
  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](/en/guia-api-key) to create and revoke keys.
</Note>

<Note>
  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.
</Note>

<Warning>
  `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.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/en/autenticacao">
    How to authenticate your calls with an API key.
  </Card>

  <Card title="Integration examples" icon="code" href="/en/guias/exemplos-integracao">
    Complete use cases with cURL, JavaScript, and Python.
  </Card>
</CardGroup>