> For the complete documentation index, see [llms.txt](https://whitepaper.open-data-rights.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://whitepaper.open-data-rights.org/proposal/api-formatting.md).

# API Formatting

This page describes the structure of the public API that must be exposed by a Open Data Rights-compliant API. The API endpoint is described in the [Open API 3 standard in the GitHub repository](https://github.com/aeon-data-requests/open-data-rights-api/blob/main/spec/openapi.json). Please find a detailed overview of responses, parameters and endpoint in the [API Endpoint Documentation](https://bump.sh/doc/open-dsar-api).

The API consists is REST-based, and can be operated language-agnostically. All responses are either in `application/json` , `text/plain` or `application/zip` for specialised endpoints. Any POST parameters must always be supplied in a `application/json` request body. Requests which require authentication must follow OAuth standards, with use of a `Bearer`-token on the `Authorization` header.

### Authentication

Authentication for this API is OAuth based, and are described more intricately on the *Authentication page:*

{% content-ref url="/pages/-MNDr77hRh3cVEE\_tzo0" %}
[Authentication](/proposal/authentication.md)
{% endcontent-ref %}

### [Data Endpoint](https://bump.sh/doc/open-dsar-api#endpoint-data)

This endpoint describes the data practices of the organisation, as well as how those practices impact the user. The inner workings of the data endpoint are documented on the *Describing Data* page:

{% content-ref url="/pages/-MNDfS70IBC02xqhLw7A" %}
[Describing Data](/proposal/describing-data.md)
{% endcontent-ref %}

### [Settings Endpoint](https://bump.sh/doc/open-dsar-api#endpoint-settings)

The settings endpoint describes the operation criteria for the specific instance of the Open Data Rights API. The available parameters, along with implementation instructions are available as part of the API Endpoint documentation.

### [Requests Endpoint](https://bump.sh/doc/open-dsar-api#endpoint-requests)

This endpoint describes currently ongoing requests, how to request a new archive, archive status and archive download when the request is complete. As part of a new request a third party may supply a JSON array with all `context`-types that are requested from the organisation for the user. If no request body is supply, all processed data types are requested for the authenticated user.


---

# 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://whitepaper.open-data-rights.org/proposal/api-formatting.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.