# WhiteIntel API

## Overview

Welcome to the WhiteIntel API documentation! This API provides access to data on WhiteIntel. It is designed for enterprise-level subscriptions and offers a variety of endpoints to interact with the WhiteIntel platform.

## Access and Usage

The WhiteIntel API is currently available only for enterprise-level and threat intelligence subscriptions. 

## Getting Started

To get started with the WhiteIntel API, you will need to obtain an API key. This key is used to authenticate your requests and ensure you have the necessary permissions to access the data.

### Obtaining an API Key

To obtain an API key, refer to the Authentication API documentation in this wiki. The Authentication API will guide you through the process of generating your API key.

### Using the API Key

Once you have obtained your API key, include it as a parameter in your POST requests. The parameter name is `apikey`.

### Example Request

Here is an example of how to make a request to the WhiteIntel API using `curl`:

```sh
curl -X POST https://api.whiteintel.io/endpoint \
     -H "Content-Type: application/json" \
     -d '{
           "apikey": "your_api_key_here",
           "other_parameter": "value"
         }'
```


---

# 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.whiteintel.io/whiteintel-api-doc/whiteintel-api.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.