> For the complete documentation index, see [llms.txt](https://docs.vectra.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vectra.ai/configuration/access/api-rux/rux-api-postman-quick-start-guide.md).

# RUX API Postman quick start guide

Our [Vectra Platform Postman Collection](https://www.postman.com/vectra-internal/workspace/vectra-ai/collection/1058623-cc38478b-7261-4e59-8768-1cf61a68ec5d) provides a great quick start introduction to what you can do with the Vectra Platform API.

**Before you begin:** Please note that these instructions apply only to the Vectra AI Platform and versions 3.0+ Vectra Platform REST API. To determine if you're on the Vectra AI Platform (aka Respond UX deployment), your Vectra login url should end in `.portal.vectra.ai`.

Follow these steps to get up and running with our public Postman collection and the Vectra Platform API:

**1.** In your RUX instance, navigate to *Configuration → ACCESS → API Clients.*

<figure><img src="/files/d76GcJxmDUgfUjcDaVQN" alt="" width="563"><figcaption></figcaption></figure>

**2.** Create a new API Client.

<figure><img src="/files/Gx8zHe99wKCRBcHGcWpZ" alt="" width="563"><figcaption></figcaption></figure>

**3.** Record your API Client's Client ID and Secret Key for later use.

<figure><img src="/files/FXKoOSJsRr2W34OMOBUB" alt="" width="563"><figcaption></figcaption></figure>

**4.** Fork the [Vectra Platform Postman Collection](https://www.postman.com/vectra-internal/workspace/vectra-ai/collection/1058623-cc38478b-7261-4e59-8768-1cf61a68ec5d) to your own public or private workspace. Forking the collection requires the use of a free Postman account. Alternatively, you can export the collection for local use if you prefer not to create a Postman account.<br>

<figure><img src="/files/3DSfqhHCi1j8ThEY8jHm" alt=""><figcaption></figcaption></figure>

**5.** If you fork the collection, you can choose to watch the original collection and get notified whenever updates are made to the original Vectra Platform collection.<br>

<figure><img src="/files/6554D5lgnu6EUeZAOC3m" alt=""><figcaption></figcaption></figure>

**6.** Once you've forked the collection to your own workspace, add your API Client's **client\_id** and **client\_secret\_key** under the Variables section of the collection. You'll also need to set the **origin** variable to the URL of your Vectra SaaS portal (be sure to include the https\:// prefix). Save the changes.<br>

<figure><img src="/files/M9WiSjPfoV795mBqpJTZ" alt=""><figcaption></figcaption></figure>

To create an Environment and configure the variables in there (and set the environment as you mentioned). Here’s a working one:

![](/files/453FtYxqxdwbFIvGH0lr)

**7.** The **access\_token**, **refresh\_token**, **expires\_a**t, and **refresh\_expires\_at** variables above will all get set dynamically as part of the OAuth2 authorization process. All other variables can be set manually later, as needed for your API testing.

* Defaults are 6 hours for access tokens, 1 day for refresh tokens
* Please see live documentation at [https://apidocs.vectra.ai](https://apidocs.vectra.ai/)

**8.** Now you can start testing out the new Vectra Platform API!<br>

<figure><img src="/files/k9TGoUowwcOK9en9MnlP" alt=""><figcaption></figcaption></figure>

**One final note:** This collection makes use of a Pre-request script, which provides a workaround for some token refresh capabilities lacking in Postman. You should not need to make any changes to the script if testing with a recent version Postman. Most other REST API tools and OAuth2 libraries can programmatically manage access and refresh tokens for you, so porting the script logic to your specific application should not be necessary.

![](/files/iSDGCiTgCgK9DHqqgpxt)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.vectra.ai/configuration/access/api-rux/rux-api-postman-quick-start-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.