> 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/concepts/foundations/activation/apis/api-reference/metadata.md).

# Metadata

Understand what a data product exposes: models, columns, semantic schema, lineage, and BI tool artifacts. Start here when onboarding a new consumer or building a catalog UI.

{% hint style="info" %}
**Fingerprint tip:** The `fingerprint` field changes whenever a new plan is applied. Cache it and compare to detect schema changes cheaply — no need to diff the full response body.
{% endhint %}

<details>

<summary>GET /api/v1/metadata</summary>

**Summary:** Full product metadata

**Description:** Returns product info, all models with columns and types, the dependency graph (lineage), gateway config, and a `status` array showing freshness (`is_pending`, last run time, cron boundaries) for each model.

**cURL:**

{% code title="Full metadata" %}

```bash
curl -s https://$BASE_URL/api/v1/metadata \
  -H "Authorization: Bearer $TOKEN"
```

{% endcode %}

**Returns:** JSON object with `name`, `env`, `fingerprint`, `models[]` (name, kind, cron, columns), `graph` (nodes + edges), `gateway`, and `status[]` (one freshness entry per model).

</details>

<details>

<summary>GET /api/v1/metadata/semantic</summary>

**Summary:** Semantic schema

**Description:** Lightweight representation of the semantic layer — models, measures, dimensions, and named metrics. Use to populate a query builder or discover which metrics you can call via `/query/metric/{name}`.

**cURL:**

{% code title="Semantic schema" %}

```bash
curl -s https://$BASE_URL/api/v1/metadata/semantic \
  -H "Authorization: Bearer $TOKEN"
```

{% endcode %}

**Returns:** JSON object with `name`, `tenant`, `fingerprint`, and `models[]` — each model lists its `kind` (SEMANTIC or METRIC) and `columns[]` with `kind` (measure/dimension) and `name`.

</details>

<details>

<summary>GET /api/v1/metadata/exports/powerbi</summary>

**Summary:** Download Power BI artifact (.zip)

**Description:** Downloads Power BI connection files as a ZIP generated at the last prod deployment. Only available in the `prod` environment.

**cURL:**

{% code title="Power BI export" %}

```bash
curl -o powerbi.zip https://$BASE_URL/api/v1/metadata/exports/powerbi \
  -H "Authorization: Bearer $TOKEN"
```

{% endcode %}

**Returns:** Binary `application/zip` file. **404** if not in prod or artifact not yet generated.

</details>

<details>

<summary>GET /api/v1/metadata/exports/tableau</summary>

**Summary:** Download Tableau artifact (.zip)

**Description:** Same as the Power BI export but for Tableau connection files.

**cURL:**

{% code title="Tableau export" %}

```bash
curl -o tableau.zip https://$BASE_URL/api/v1/metadata/exports/tableau \
  -H "Authorization: Bearer $TOKEN"
```

{% endcode %}

**Returns:** Binary `application/zip` file. **404** if not in prod or artifact not yet generated.

</details>


---

# 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/concepts/foundations/activation/apis/api-reference/metadata.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.
