# API Overview

{% hint style="info" %}
Access to the API requires a [**Pro**](https://docs.houdin.io/more/pro-plan) or [**Enterprise**](https://docs.houdin.io/more/enterprise-plan) Plan
{% endhint %}

The Houdin API aims to reproduce the **simplicity of use** of the WebApp while **supercharging** its capabilities. Connect our **all-in-one API** to your SOAR system instead of setting up multiple playbooks for each service.

### :gift: ALL the data

API queries return the **full reponses** for each queried scanner !\
The Houdin API is appropriate for **any level of granularity** you need, from the most simple scanning use cases to deep automated investigation requiring advanced sandboxing information.

### :key: Privacy focused

BYOAK: Bring Your Own API Keys ! ~~(I know, the acronym is weird)~~

For each scanner, use your own API keys to launch **fully private scans**, keep control over quotas, scopes and storage of the keys.

### :crown: One API Call To Rule Them All

Just send **any artifact format** and we'll automatically detect it and run the appropriate scanners.\
**No more maintenance** costs for a hundred different APIs with ever-changing specifications, we handle everything !

### :star: Premium keys = premium scans

We adapt the data returned based on your API Key's capabilities.\
Example:

A VirusTotal Premium API Key can query more information than a Free API Key, including:

* Behavioral sandbox results
* ExifTool output
* File similarity search
* VT Graph, VT Intelligence, and wayyy more

### :frog: Simple setup

Don't know where to start ? Test our API endpoints on the **interactive Swagger User Interface** before integrating into your SOAR solution. Understand the workflow in **only a few clicks**.

{% embed url="<https://app.houdin.io/swagger>" %}