# API

The provided APIs are:

* POST `/rank`

## `/rank`

As already introduced in the [Running the Cloud Provider Ranker](/cloud-provider-ranker/running.md) chapter, it performs the ranking of the services provided by cloud providers based on an internal algorithm which uses weights and normalization parameters (described in the [Ranking Algorithm](/cloud-provider-ranker/ranking_algorithm.md) chapter).

The payload the client must send in a POST HTTP request is described in the [Ranking Algorithm](/cloud-provider-ranker/ranking_algorithm.md) chapter.

The [Ranking JSON request format](/cloud-provider-ranker/json_request_format.md) chapter describes the request the user must submit to the `/rank` API, and the [Ranking JSON response format](/cloud-provider-ranker/json_response_format.md) chapter describes the format of the returned response.


---

# 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://indigo-dc.gitbook.io/cloud-provider-ranker/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.