> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/references/v1/readme.md).

# Overview

References holds the full technical detail behind DataOS: the full per-engine manuals, the complete syntax for every DataOS resource, and the interface specifications. Where Build and Consume show you how to do a task, References is what those pages link out to when you need the depth; each fact lives here once.

Use References when a task page sends you here for the full detail, or when you already know what you need and want the reference directly.

## What is here

<table data-view="cards"><thead><tr><th></th><th data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Engine guide</strong><br>The full technical manual for each engine you build Data Products on. Covers connection, permissions, materialization internals, local development, tuning, and failure modes.</td><td><a href="/pages/WQHbRcaltQkfaKUWCAO5">/pages/WQHbRcaltQkfaKUWCAO5</a></td></tr><tr><td><strong>DataOS Resources</strong><br>The complete reference for every resource. Includes Vulcan, Nilus, Lakehouse, Minerva, Secret, Depot, and the rest.</td><td><a href="/pages/Cocyyi1ghwudGfqjSpN4">/pages/Cocyyi1ghwudGfqjSpN4</a></td></tr><tr><td><strong>Interfaces</strong><br>The ways to reach a Data Product, including APIs, BI tools, database clients, AI activation, and the CLI.</td><td><a href="/pages/uB5hOxFpQtH1xYANoz0o">/pages/uB5hOxFpQtH1xYANoz0o</a></td></tr></tbody></table>

If you are new to building or consuming, start in [Build](https://v2.dataos.info/build) or [Consume](https://v2.dataos.info/consume); they bring you here when you need the underlying detail.


---

# 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://v2.dataos.info/references/v1/readme.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.