# API  Overview

GraphQL is a query language for our API. It's beneficial for large datasets as it allows for selecting specific objects and fields rather than committing to all data returned by a REST API endpoint. GraphQL is very beneficial for large datasets as it provides for greater flexibility and higher performance API endpoints. Send a GraphQL query to our API and get exactly what you need. GraphQL queries always return predictable results. 

Additionally, it allows us to evolve our API without the need for versioning. 

If you're not familiar with GraphQL, we suggest that you check it out from the link below. 

{% embed url="<https://graphql.org/>" %}

### GraphQL Endpoint

While typical REST APIs require loading from multiple URLs, GraphQL APIs get all the data your app needs in a single request. Apps using GraphQL can be quick even on slow mobile network connections.

Our GraphQL API is located at:

```
https://app.threatrix.io/graphql
```

Our GraphQL is self-documenting. As such, documentation is provided from our GraphQL Explorer endpoint that allows for exploration, documentation, and live queries testing against our API.&#x20;

Visit our GraphQL Explorer tool here:&#x20;

```
https://app.threatrix.io/graphiql
```

### Authentication

Our GraphQL API endpoint requires authentication with an API token.&#x20;

Generate user API token

[Generate Admin API token](/administration/organization-settings/integration/api-keys.md)

Example Queries


---

# Agent Instructions: 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:

```
GET https://docs.threatrix.io/graphql-api/api-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.