# API Reference

### **Base URL**

```
https://api.vcodes.xyz/
```

### API Versioning <a href="#api-versioning" id="api-versioning"></a>

vCodes exposes different versions of our API. You should specify which version to use by including it in the request path like `https://api.vcodes.xyz/v{version_number}`.

| VERSION | STATUS       | DEFAULT |
| ------- | ------------ | ------- |
| 0       | Discontinued |         |
| 1       | Available    | ✓       |

{% hint style="danger" %}
**Version number** is required.
{% endhint %}

### Authentication <a href="#authentication" id="authentication"></a>

Authentication is performed with the `Authorization` HTTP header in the format `Authorization: Bot TOKEN`. Using a bot token gained by [submit a bot](https://vcodes.xyz/bot/submit).

**Example Bot Token Authorization Header**

```
Authorization: Bot eyJhbGciOiJIUzI1NiJ9....
```

<br>


---

# 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.vcodes.xyz/reference.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.