# Getting started

{% hint style="warning" %}
API is currently under development. Stay tuned to the [project repository](https://github.com/quranacademy/digital-quran-docs) on GitHub.
{% endhint %}

First of all, you need to [create an application](/digital-quran/api/creating-an-application.md).

After registering the app you will receive credentials for [authentication](/digital-quran/api/authentication.md).

Base API URL is <https://digital-quran.quranacademy.org>.

## General concepts

* API works exclusively over HTTPS.
* Every API request must include the "Language" header with the code of a language. See the [list of available languages](https://github.com/quranacademy/digital-quran-docs/tree/897278b43c9c88853ed2c939278b8d7f042acb77/api/available-languages.md).
* Every request to the API must be authenticated.
* API always returns HTTP code 200 if the request is correctly handled by the server.
* API returns data in JSON format.


---

# 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://quranacademy.gitbook.io/digital-quran/api/getting-started.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.
