> 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/interfaces.md).

# Interfaces

- [Understand Interfaces](https://v2.dataos.info/references/interfaces/overview.md): The ways to query, connect to, and operate Data Products through APIs, BI tools, database clients, AI assistants, and the CLI.
- [APIs](https://v2.dataos.info/references/interfaces/apis.md): Choose between the Data Product APIs and the Core APIs for building on DataOS.
- [Data Product APIs](https://v2.dataos.info/references/interfaces/apis/data-product-apis.md): Explore the Data Product API surface for governed discovery, queries, reusable results, and operational insights.
- [Getting started](https://v2.dataos.info/references/interfaces/apis/data-product-apis/getting-started.md): A practical introduction to Data Product API access, requests, and error recovery.
- [Authentication & authorization](https://v2.dataos.info/references/interfaces/apis/data-product-apis/getting-started/authentication.md): Secure Data Product API calls with DataOS tokens, identity checks, and access controls.
- [API calls](https://v2.dataos.info/references/interfaces/apis/data-product-apis/getting-started/api-calls.md): Core HTTP conventions for calling a Data Product API, including URLs, pagination, and Postman.
- [Error codes](https://v2.dataos.info/references/interfaces/apis/data-product-apis/getting-started/error-codes.md): Reference for identifying API failures and choosing the right recovery action.
- [Querying Data Products](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products.md): Guidance for matching Data Product query interfaces to integration and analytics needs.
- [REST](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/rest.md): Reference for expressing semantic analytics through structured JSON requests.
- [Semantic SQL](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/semantic-sql.md): A SQL-oriented interface for analyzing governed business definitions.
- [GraphQL](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/graphql.md): A typed API for selecting Data Product fields and receiving nested results.
- [Metrics](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/metrics.md): A focused interface for reading approved KPI time series.
- [Perspectives](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/perspectives.md): Turn a successful query into a reusable, governed data asset.
- [Advanced](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced.md): Deeper guidance for selecting, executing, and extending Data Product queries.
- [Choosing a query method](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced/choosing-a-query-method.md): Compare the available query interfaces and select the right fit for your integration.
- [Query lifecycle](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced/query-lifecycle.md): Learn how asynchronous requests progress from submission to a final result or error.
- [Measure and dimension behavior](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced/measure-and-dimension-behavior.md): Clarify the semantic rules that shape calculations, grouping, filtering, and relationships.
- [Cross-model queries](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced/cross-model-queries.md): Combine related business entities in a single governed analytical request.
- [Source SQL](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced/source-sql.md): Use the physical data layer only for questions beyond the semantic model.
- [Statement lifecycle](https://v2.dataos.info/references/interfaces/apis/data-product-apis/querying-data-products/advanced/statement-lifecycle.md): Detailed sequence diagrams walking through the statement lifecycle, step by step.
- [SDKs](https://v2.dataos.info/references/interfaces/apis/data-product-apis/sdks.md): Client libraries for building typed Data Product API integrations.
- [Python SDK](https://v2.dataos.info/references/interfaces/apis/data-product-apis/sdks/python-sdk.md): A typed Python client for integrating applications with Data Product APIs.
- [TypeScript SDK](https://v2.dataos.info/references/interfaces/apis/data-product-apis/sdks/typescript-sdk.md): A fully typed TypeScript client for integrating applications with Data Product APIs.
- [API reference](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference.md): Endpoint specifications for integrating with the Data Product API.
- [Discover](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/discover.md): Find the API contracts that expose a Data Product's metadata and semantic model.
- [Query](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/query.md): API contracts for running analytical requests and working with their outputs.
- [GraphQL](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/graphql.md): Technical contract for GraphQL schema access and execution.
- [Perspectives](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/perspectives.md): Technical contract for managing saved, reusable query results.
- [Engagement](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/engagement.md): Technical contract for working with consumer engagement data.
- [Quality & Activity](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/quality-and-activity.md): Technical contract for quality information and operational activity.
- [Health](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/health.md): Technical contract for checking service availability and runtime health.
- [Core APIs](https://v2.dataos.info/references/interfaces/apis/core-apis.md): Reference for platform-api: list tenant apps and links, and search logs for tenant resources.
- [Authentication](https://v2.dataos.info/references/interfaces/apis/core-apis/authentication.md): Authenticate platform-api requests with a Bearer token or apikey header, plus optional tracing headers.
- [API reference](https://v2.dataos.info/references/interfaces/apis/core-apis/api-reference.md): Endpoint index for platform-api, covering tenant apps and links, and log search.
- [Tenant apps & links](https://v2.dataos.info/references/interfaces/apis/core-apis/api-reference/tenant-resources.md): List the apps and links registered for a tenant, with optional filtering by product.
- [Log search](https://v2.dataos.info/references/interfaces/apis/core-apis/api-reference/logs-search.md): Search logs for a tenant resource with the v1 (grouped by pod) or v2 (flat list) endpoint.
- [CLI](https://v2.dataos.info/references/interfaces/command-line-interface.md): Use the CLI to manage DataOS Resources.
- [Resource commands](https://v2.dataos.info/references/interfaces/command-line-interface/resource.md): Reference for dataos-ctl resource commands.
- [Lakehouse commands](https://v2.dataos.info/references/interfaces/command-line-interface/lakehouse.md): Reference for dataos-ctl lakehouse commands.
- [User commands](https://v2.dataos.info/references/interfaces/command-line-interface/user.md): Reference for dataos-ctl user commands.
- [Apps](https://v2.dataos.info/references/interfaces/apps.md): Build applications on a Data Product, then deploy them in DataOS or link an externally hosted app.
- [Deploy a data application](https://v2.dataos.info/references/interfaces/apps/deploy-a-data-application.md): Run a data application from a container image in DataOS using an app Resource.
- [Link an external application](https://v2.dataos.info/references/interfaces/apps/link-an-external-application.md): Register an externally hosted application as a link Resource so consumers can find it in DataOS.
- [BI tools](https://v2.dataos.info/references/interfaces/bi-tools.md): Connect Tableau, Power BI Desktop, or Power BI Service to a Data Product's semantic layer.
- [Tableau Desktop](https://v2.dataos.info/references/interfaces/bi-tools/tableau.md): Download the Tableau .tds project, then review supported types, limits, and troubleshooting.
- [Tableau Cloud](https://v2.dataos.info/references/interfaces/bi-tools/tableau-cloud.md): This page covers everything beyond the initial setup.
- [Power BI Desktop](https://v2.dataos.info/references/interfaces/bi-tools/power-bi-desktop.md): Download the Power BI .pbip project, then review supported types, limits, and troubleshooting.
- [Power BI Service](https://v2.dataos.info/references/interfaces/bi-tools/power-bi-service.md): How Power BI Service connects to DataOS through a gateway, plus limitations and troubleshooting.
- [Database clients](https://v2.dataos.info/references/interfaces/db-clients.md): Query a Data Product's semantic models with plain SQL from any MySQL-compatible client.
- [AI activation](https://v2.dataos.info/references/interfaces/ai-activation.md): Explains AI activation in DataOS and how Data Product MCP connects governed Data Products to AI assistants.
- [MCP components](https://v2.dataos.info/references/interfaces/ai-activation/mcp-components.md): Understand the MCP host, client, server, tools, resources, and prompts used in AI activation.
- [MCP layers](https://v2.dataos.info/references/interfaces/ai-activation/mcp-layers.md): Understand the data and transport layers used by Data Product MCP.
- [Data Product MCP lifecycle](https://v2.dataos.info/references/interfaces/ai-activation/data-product-mcp-lifecycle.md): See how a Data Product MCP session initializes, operates, and ends.
- [Request flow](https://v2.dataos.info/references/interfaces/ai-activation/request-flow.md): Follow how a user prompt becomes a governed Data Product MCP response.
- [Authentication and authorization](https://v2.dataos.info/references/interfaces/ai-activation/authentication-and-authorization.md): See how Data Product MCP enforces DataOS identity, access, and policy controls.
- [Consumer journey](https://v2.dataos.info/references/interfaces/ai-activation/consumer-journey.md): See how AI activation helps users find, trust, query, and act on governed Data Products.
- [Builder journey](https://v2.dataos.info/references/interfaces/ai-activation/builder-journey.md): See how AI activation supports discovery, design, planning, build, and validation of Data Products.
- [Trust model](https://v2.dataos.info/references/interfaces/ai-activation/trust-model.md): Understand the governance and assistant trust boundaries in AI activation.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://v2.dataos.info/references/interfaces.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.