> For the complete documentation index, see [llms.txt](https://whitepaper.interthedungeon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://whitepaper.interthedungeon.com/community-interoperability/api.md).

# API

We are creating a productized API using best practices. 

All APIs start with an [OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification that has been well thought out and developed with the help of [APICURIO Studio](https://www.apicur.io/) and [Microcks](https://microcks.io/). The OpenAPI specification is used to generate code, documentation, mock endpoints, etc. Ultimately, the API developed is managed via [3Scale](https://www.3scale.net/) and easily scaled with [Openshift](https://www.redhat.com/en/technologies/cloud-computing/openshift).

![Open API Spec Authoring Tool (Source View)](/files/eCucutsbGgWhLJ5y9vOY) ![Design View](/files/JfztGO5H8tfEzVRv3iVh)

![Generates the mock endpoints based on the Open API specifications](/files/bn91snKGrlkxq6tGLpOV)

![API Management Software](/files/XuHezXPBXgQLJ9d6b45F)


---

# 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.interthedungeon.com/community-interoperability/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.