> For the complete documentation index, see [llms.txt](https://docs.zaui.com/zapi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zaui.com/zapi/getting-started/api-specification.md).

# API Specification

We've been so busy building great features on the platform, that our API docs are still in PDF form.  We will continue to migrate this over as time permits.  

In the meantime, you can download the API spec in PDF.

{% file src="/files/-MT7X\_32wETzk\_98lrJa" %}
Zaui API Spec v1-2021-02-09
{% endfile %}

## XML vs JSON Requests/Responses

While our API documents are in XML, our XML is smart enough to talk in JSON also.  To enable the API in JSON add `/?responseType=json` to the base URL endpoint.

If your requests are in JSON then our API will reply in JSON.


---

# 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:

```
GET https://docs.zaui.com/zapi/getting-started/api-specification.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.