> For the complete documentation index, see [llms.txt](https://docs.violetlabs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.violetlabs.com/features/api/endpoints.md).

# Endpoints

## Getting started

First, you'll need to [Generate an API key](/features/api/generate-an-api-key.md).

Next, your API endpoint is either:

* `https://[YOUR-TENANT-NAME].violetlabs.com/api/` for Violet customers
* `https://[YOUR-TENANT-NAME].violetgov.com/api/` for VioletGov customers

*Note: If you wish to access an API endpoint to your Violet Staging sandbox environment, use the* `https://[YOUR-TENANT-NAME].staging.violetlabs.com/api/` or `https://[YOUR-TENANT-NAME].staging.violetgov.com/api/`  *endpoints*.

### Available Endpoints

* [Explore](/features/api/endpoints/explore.md) – Query your Violet data using the same filters and columns available in the Data Explorer.
* [Entities](/features/api/endpoints/entities.md) – Retrieve a broad set of properties and metadata for one or more entities by ID, including thumbnail URLs.
* [Relationships](/features/api/endpoints/relationships.md) – Query relationships between entities, such as the PO Lines on a Purchase Order or the Parts in an Assembly.
* [Activities](/features/api/endpoints/activities.md) – Query activity and change history across your Violet tenant or for a specific entity.

### Try it out in Postman

To test in [Postman](https://postman.com/):

1. Create a new Postman request, select the `POST` method, and populate your URL (eg. <https://magictoaster.violetlabs.com/api/explore/>)
2. In the Authorization tab, select **API Key** in the Auth Type dropdown. Enter `x-api-key` for the Key, and populate your API key for the Value.

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2F8ffvA6smXgSFdqQ5TVh4%2FScreenshot%202026-03-10%20at%2012.34.04%E2%80%AFPM.png?alt=media&amp;token=926d847c-382e-4be3-835b-7e406adc0613" alt="" width="563"><figcaption></figcaption></figure>

3. In the Body tab, select **raw**, then paste the API payload you generated for one of the supported endpoints. Click **Send**.

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FTsjGDFIRXqgxfzcofZLG%2FScreenshot%202026-03-10%20at%2012.18.01%E2%80%AFPM.png?alt=media&amp;token=765072ff-19e8-46c9-ac8f-bab1a8aa7156" alt="" width="563"><figcaption></figcaption></figure>

4. Your results should appear below.

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FDuls4cJ9GjkggjMW6gTk%2FScreenshot%202026-03-10%20at%2012.37.07%E2%80%AFPM.png?alt=media&amp;token=38cead0b-37f5-4f23-ba96-763384eaea00" alt="" width="563"><figcaption></figcaption></figure>

5. We love using Postman's [Visualizer](https://learning.postman.com/docs/sending-requests/response-data/visualizer) to generate visualizations of your data:

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FYJtrOjtzSYnbyg0A5AjT%2FPostman%20visualizer.png?alt=media&amp;token=fd13b0bd-86d9-448c-adf7-6c58fda02656" alt="" width="563"><figcaption></figcaption></figure>


---

# 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.violetlabs.com/features/api/endpoints.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.