# Introduction

Welcome to Nuvio API Reference documentation! Here you'll find all the documentation you need to get up and running with the Nuvio API.

{% hint style="info" %}
Nuvio API is still in beta. Until we publish a stable release, there might be some breaking changes or bugs. We aim to collect feedback from the beta users during this time period and create the flawless API to provide an integrated finance platform. Thank you for your support ❤️
{% endhint %}

The Nuvio API can be used to integrate your data either from Nuvio to any external system or from any external system into the Nuvio. Using the navigation on the left, you'll find details of Nuvio API usage and endpoints.

## Conventions

The base URL to send all API requests is <mark style="color:orange;">`https://api.nuvio.io`</mark>. HTTPS is required for all API requests.

The Nuvio API follows RESTful conventions when possible, with most operations performed via <mark style="color:orange;">`GET`</mark>, <mark style="color:orange;">`POST`</mark>, <mark style="color:orange;">`PATCH`</mark>, and <mark style="color:orange;">`DELETE`</mark> requests. Request and response bodies are encoded as JSON.

### JSON conventions

* Property names are in <mark style="color:orange;">`camelCase`</mark>  (not <mark style="color:orange;">`snake_case`</mark> or <mark style="color:orange;">`kebab-case`</mark>).
* Every response body have <mark style="color:orange;">`"success"`</mark> and <mark style="color:orange;">`"error"`</mark> fields. For each successful request, success field gets <mark style="color:orange;">`"true"`</mark>, and for each failed request success field gets <mark style="color:orange;">`"false"`</mark>. When request fails, error field will have detailed error massage. Check [**Errors**](https://developers.nuvio.io/errors) page for specific error codes.


---

# 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://developers.nuvio.io/introduction.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.