# API

## Dropzone API

You can interact with your Dropzone instance via API for various actions, such as maning alerts and investiagtions, context memory, and response actions.

API key creation is available to Dropzone "Admin" users.

## Managing Keys

* Navigate to your Dropzone AI tenant home page e.g. https\://*mycompany*.dropzone.app
* In the bottom left hand corner, navigate to Settings > API Keys

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-9a7940e975598b1d0a1b4c99ea4f28d115442f64%2Fui-apikeys-dropdown.png?alt=media" alt=""><figcaption><p>API Keys Dropdown</p></figcaption></figure>

You'll now be on the API Keys page. From here you can see existing keys, create new ones, and revoke existing ones.

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-d8501329e4c9ba428a240ed5077b1b2b79f6815f%2Fui-api-keys-00.png?alt=media" alt=""><figcaption><p>The API Keys Page</p></figcaption></figure>

## Creating Keys

* Find the "Add New API Key" section in the upper left
* Give your new key a name and optional expiration date
* Hit Create Key
* Store your API key value somewhere safe - you will not be able to see it again

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-2b41601bfeecad840e0ad1f816704ee2e3db4d37%2Fui-api-keys-01.png?alt=media" alt=""><figcaption><p>Key is generated</p></figcaption></figure>

{% hint style="warning" %}
The `Api-Key` prefix is part of your api key - be sure it is included in the `Authorization` header, e.g.

```bash

curl -L \
  --url '/app/api/v1/ping' \
  --header 'Authorization: Api-Key Tm8gc2Vcm...' \
  --header 'Accept: */*'
  ...
```

{% endhint %}

## Swagger API UI

You can view the API spec from within the Dropzone UI via a [Swagger UI](https://swagger.io/tools/swagger-ui/), and even make API calls directly by using your API key in the Swagger interface.

From the main API key page, click "Dropzone API Swagger UI" link in the upper right

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-cee4b4f4a35997c9da7a15eef905f5f841fe40c1%2Fui-api-keys-02.png?alt=media" alt=""><figcaption><p>The Swagger UI Link</p></figcaption></figure>

This will open a new tab with the Swagger UI.

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-87d12f3afcdaa795d76fb76649b0cfcac9b16b1d%2Fui-api-keys-03.png?alt=media" alt=""><figcaption><p>The Swagger UI</p></figcaption></figure>

## Online API Documentation

The pages in this section detail the APIs for Dropzone AI. Note that these documents may lag actual product functionality - see the Swagger UI for the official list of APIs available to you.


---

# 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.dropzone.ai/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.