> For the complete documentation index, see [llms.txt](https://docs.epicollect.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.epicollect.net/developers/api.md).

# API

{% hint style="info" %}
A fully-fledged Developer Guide can be found at [**https://developers.epicollect.net**](https://developers.epicollect.net/)
{% endhint %}

To access the API page go to your project details **(**[**show me how**](/web-application/set-project-details.md)**)** then on the left sidebar click on API under the Developers section:

![](/files/D0IsmDw0AvTD3uj186f3)

You will get to a page with two tabs: parameters and endpoints.

The following screenshots are based on our [**EC5 API TEST project.**](https://five.epicollect.net/project/ec5-api-test)

## Parameters

You can see the main parameters of your project and the `map_index` which is the unique identifier per each of your custom mappings:

![](/files/kEXirEt5nPl8OK3jvqzL)

## Endpoints

We list the most common endpoints to get the data for the selected project. If the project is public, you can view them directly via the browser. If the project is private you will have to [register your app](/developers/apps.md).

![](/files/XJM1LHxCertmGgKlrYpB)

[**More info about Epicollect5 API.**](https://developers.epicollect.net/)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.epicollect.net/developers/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.