# API Design

The nexxOMNIA API can be complicated to handle, as there are Tons of Options and Modifiers everywhere. Nevertheless, the Structure is always identical and the Parameter Options are always covering the same Concepts, once they are used.

Make yourself familiar with the general Structure and Authorization

{% content-ref url="/pages/-M9d5XJNE-MS\_ntsnyQd" %}
[Endpoint and Authorization](/api-design/authorization.md)
{% endcontent-ref %}

The most common Parameters and Modifiers, valid for all Parts of the API, are explained here

{% content-ref url="/pages/-M9bg1HOU50nARG6A4Di" %}
[Query Parameters](/api-design/query-parameters.md)
{% endcontent-ref %}

It is impossible to layout a valid Response Object even within a single API. That is due to the Concept of Output Modifiers and List/Single Item Types. Therefore, only the basic Response Object Attributes can be described here

{% content-ref url="/pages/-M9bg4YDggx6a7GAJPlI" %}
[Response Object](/api-design/response-object.md)
{% endcontent-ref %}


---

# 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://api.docs.nexx.cloud/api-design.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.