> For the complete documentation index, see [llms.txt](https://docs.roleplaybot.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roleplaybot.xyz/api/guides/starting.md).

# Getting Started

{% hint style="danger" %}
The API has been deprecated and is no longer in use.
{% endhint %}

### Prerequisites

* Access to a REST Client (Recommended For PC, [Insomnia](https://insomnia.rest/download))
* Basic knowledge of computing
* Access to a computer (**HIGHLY RECOMMENDED**)
* Authorization Key
* Your Guild ID

### Requirements

Firstly, We will start by accessing an Authorization key for your server (Need a key? [View here](/api/guides/authorization.md#getting-a-key)) and getting your guild ID. Authorization keys secure the API and restrict only authorized users from accessing sensitive guild data, Your guild ID is required to access and send data specific to your guild. Need help getting your guild ID? [View here](https://github.com/manix84/discord_gmod_addon_v2/wiki/Finding-your-Guild-ID-%28Server-ID%29).

### Getting started

Now, Lets make a request to the API using the fields we just gathered.

## API Version

<mark style="color:blue;">`GET`</mark> `https://roleplaybot.xyz/api/version`

Returns the current API version

#### Headers

| Name                                            | Type      | Description           |
| ----------------------------------------------- | --------- | --------------------- |
| Authorization<mark style="color:red;">\*</mark> | API\_KEY  | API Authorization Key |
| Guild<mark style="color:red;">\*</mark>         | GUILD\_ID | Discord Guild ID      |

{% tabs %}
{% tab title="401: Unauthorized Invalid Authorization Key (Field empty or invalid key)" %}

```javascript
{
	"authentication": false,
	"error": "401 Unauthorised",
	"details": "Invalid Authorization key (20050)"
}
```

{% endtab %}

{% tab title="200: OK Successful Request" %}

```javascript
{
    "version": "v1.1.xx"
}
```

{% endtab %}
{% endtabs %}

### Advancing

To advance further check out our other Guides!