---
title: Installation
slug: installation
docTags: 
createdAt: 2023-05-07T17:58:31.000Z
---

You can seamlessly integrate AIShield Vulnerability Assessment and Defense capabilities into your AI development workflows. With AIShield, you can generate assessment reports, sample attack vectors, and a threat-informed defense model with telemetry connection to SIEM/SOAR, such as Splunk and Microsoft Sentinel.

There are two ways to get started with AIShield:

1.)  Installing using [pypi package](https://pypi.org/project/aishield/)
2.) Directly using AIShield APIs

**Requirements**

Requires Python>=3.6, and pip >= 19.0

## Installation using pypi package

```python
$ pip install aishield
```

Enum for parameters:

- **analysis **: 
  - extraction
  - evasion
  - poisoning
-  **task**: 
  - image\_classification
  - image\_segmentation
  - timeseries\_forecasting
  - nlp
  - tabular\_classification
  - text\_recommendation
  - object\_detection
-  **report\_type**: 
  - vulnerability
  - defense
  - defense\_artifact
  - attack\_samples

## Directly use AIShield APIs

```python
"""
Description: AIShield API URL and subscription key
""" 
baseurl = "https://api.aws.boschaishield.com/prod" 
url = baseurl + "/api/ais/v1.5"
headers={'Cache-Control': 'no-cache',
'x-api-key': "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", # follow instruction to generate API key and fill it here
'Org-Id' : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  # fill in Org_Id provided in welcome email
}
```

Here are the installation steps for AIShield using its direct APIs:

1. You will get the **Org-ID** from the welcome email sent to you registered mail id.
2. You will also receive instruction and URL in welcome email, which you can use to generate API key (x-api-key). 
3. Assign the `baseurl` concatenated with `"/api/ais/v1.5"` to the `url` variable.
4. Create a headers dictionary with the following key-value pairs:
   - `'Cache-Control': 'no-cache'`
   - `'x-api-key':`  *insert your subscription key / API key here*
   - `'Org-Id' :`  *insert your Org-ID here*
5. You can now make requests to the AIShield API using the `url` and `headers` variables.

:::hint{type="info"}
After installation, you can have to register you model using [\<POST> Model Registration](docId\:Qknp3vmRQaWJeZAeoChlH) API. To learn more, please refer this [Reference implementation](https://colab.research.google.com/github/bosch-aisecurity-aishield/Reference-Implementations/blob/main/Product_Taskpair_wise/Image_Classification/Evasion/Evasion_Reference_Implementation_MNIST.ipynb) and view section 5.
:::

## Details

Check out the Quick Start Example [here](https://github.com/bosch-aisecurity-aishield/Reference-Implementations/tree/main/Product_Taskpair_wise/Image_Classification).

More references implementations, tutorials, samples, and documentation of AIShield can be found on our [Github Repository](https://github.com/bosch-aisecurity-aishield/Reference-Implementations).

**Pre-requisites:**

- AIShield API should be white-listed, or proxy settings must be appropriately configured for the AIShield API to be called.
- Valid AIShield API subscription plan and authentication keys. For details regarding subscription please visit, [Subscription Page](https://aws.amazon.com/marketplace/pp/prodview-ppbwtiryaohti) or reach out to sales at [AIShield.Contact@bosch.com](#)