# Introduction

Welcome to the Node Social API documentation. This guide provides developers with all the information needed to interact with the API.

**API Version:** `1.1` "Vega"

**Base URL:** `https://api.nodesocial.org/`

All API endpoints are relative to this base URL. Throughout this documentation, the base URL will be referred to as `{base}`.

## Versioning

The Node Social API follows a `major.minor.patch-hotfix` versioning scheme (e.g., `1.6.3-9`).

This documentation is manually updated for each `minor` release. For the most up-to-date details, including `patch` and `hotfix` changes, please refer to our auto-generated OpenAPI specification, which is always available at [api.nodesocial.org/swagger/index.html](https://api.nodesocial.org/swagger/index.html).

## Requests & Headers

The API exclusively uses JSON for requests and responses. All requests must include the `Content-Type: application/json` header.

<pre class="language-json" data-title="Header" data-full-width="false"><code class="lang-json"><strong>"Content-Type": "application/json"
</strong></code></pre>

Every field that has, for example, `"string"`, it means the data type you're supposed to use.

### Authentication

Endpoints marked with an asterisk (`*`) require authentication. These requests must include an `Authorization` header containing a bearer token.

{% code title="Header" %}

```json
"Authorization": "Bearer ${token}"
```

{% endcode %}

A complete header for an authenticated request requiring a JSON body would look like this:

{% code title="Header" %}

```json
{
    "Content-Type": "application/json",
    "Authorization": "Bearer ${token}"
}
```

{% 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://docs.nodesocial.org/readme.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.