# API

## Configuration

* To use the service which permit to users to open issues (about missing words in the dictionary), create a `.github.json`, file which contains the following:

```json
{
  "token": "ghp_XXXXXXXX",
  "repo": "camarm-dev/remede",
  "labels": ["word"],
  "assignees": ["camarm-dev"]
}
```

* To serve the database you need to [download it](/developers/develop-on-remede/setup.md#fetch-database).

## Developing

Remède API is built using [FastAPI](https://fastapi.tiangolo.com/).

You can modify it inside the `server.py` file at project root.

An *open API* documentation generated by FastAPI can be found at [api-remede.camarm.fr](https://api-remede.camarm.fr/docs).

## Start API

```shell
python3 server.py
```

Running on [localhost:8000](http:/localhost:8000) !

Documentation available at [localhost:8000/docs](http:/localhost:8000/docs).


---

# 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.remede.camarm.fr/developers/develop-on-remede/api.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.