# Accessing the API

## Getting started

In order to use the API you must download and import it into your project. Follow the steps below to do this before moving forward.

{% hint style="info" %}
**Download**

Go to <https://chatsentry.xyz/api-download> to download the API jar

The latest version is 1.1.0, released 1/5/26
{% endhint %}

### **Importing with IntelliJ**

1. Click on **File** -> **Project Structure** (Ctrl + Alt + Shift + S on windows)
2. Go to the **Modules** tab, then to the **Dependencies** subtab
3. Click the **+** on the bottom left side and choose **Library...** -> **Java** (see below image)
4. Choose your downloaded API jar

![](/files/-MZebxr3rJDeBmRERi3M)

### **Importing with Eclipse**

1. Right-click your project and choose **Properties** -> **Java Build Path**
2. Click on **Add external jar** and add your downloaded API jar

## Setting up your plugin

The next step is to go to your **plugin.yml** and add **ChatSentry** as a depend or softdepend, depending on if it is optional or not for your plugin to work

{% hint style="info" %}
**softdepend** is used if your plugin works without ChatSentry installed on the server

**depend** is used if your plugin requires ChatSentry to be installed on the server
{% endhint %}

{% code title="Example plugin.yml" %}

```yaml
name: ACoolPlugin
version: 0.0.1
author: epic-programmer
main: main.path
depend: [ChatSentry]
```

{% endcode %}


---

# 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://wiki.chatsentry.xyz/api/accessing-the-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.