> 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.md).

# API

The Violet API gives you programmatic access to the data in your Violet environment, so you can pull it into your own scripts, reports, dashboards and internal tools. It's the same data you see in Violet, across all your connected apps, available over standard HTTPS requests at `https://[YOUR-TENANT-NAME].violetlabs.com/api/` (or `violetgov.com` for VioletGov customers).

To get started, [generate an API key](/features/api/generate-an-api-key.md) and include it in the `x-api-key` header of each request. Then head to [Endpoints](/features/api/endpoints.md) for request details, a walkthrough for testing in Postman, and documentation for each available endpoint:

* **Explore:** query your data using the same filters and columns as the Data Explorer.
* **Entities:** retrieve detailed properties and metadata for specific entities.
* **Relationships:** traverse relationships between entities.
* **Activities:** review activity and change history.


---

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