> 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/consume/activate/apis.md).

# APIs

Connect applications and automation to Data Products with GraphQL, semantic query, metadata, activity, and quality APIs.

Use Data Product APIs when an application, script, or automation needs governed access outside BI tools and SQL clients.

The **Build on the APIs** page gives you everything you need to wire a Data Product into your code in one place. From the Data Product page, select **Activate → APIs** to open it: three cards sit in one row. Download the [Postman collection](https://v2.dataos.info/consume/activate/apis/collection.md) to start testing fast, open the in-product **APIs documentation** for the full reference, or use the **SDK** card for a direct deep link into the [Python](https://v2.dataos.info/consume/activate/apis/sdk/python-sdk.md) or [TypeScript](https://v2.dataos.info/consume/activate/apis/sdk/typescript-sdk.md) client if you want typed code over raw HTTP.

{% hint style="info" %}
The APIs documentation lets you confirm exactly how each call behaves before you write code: every API group (GraphQL, Data APIs, Metadata APIs, Activity APIs, and Quality APIs) comes with the base URL, request body, responses, and live response samples per endpoint.
{% endhint %}

## Before you start

Before calling any endpoint:

1. Generate a [DataOS API token](https://v2.dataos.info/consume/get-started/before-you-begin.md).
2. Confirm the Data Product exposes [semantic models](https://v2.dataos.info/consume/evaluate/assets/semantics.md) if you plan to query data.
3. Validate the fields you need in [Query in Studio](https://v2.dataos.info/consume/evaluate/query-in-studio.md), or discover them programmatically via the [metadata endpoints](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference/discover), before you automate the call.

## Authentication

Use a Bearer token in the `Authorization` header.

```http
Authorization: Bearer <your-token>
```

All API groups use the same Data Product base URL:

```
https://<instance-url>/vulcan/tenants/<tenant>/data-products/<tenant>-<data-product>/
```

{% hint style="warning" %}
Replace `<instance-url>`, `<tenant>`, `<data-product>`, and `<your-token>` with the values from the Data Product **Connect** tab and your [API token](https://v2.dataos.info/references/key-concepts/api-tokens) before running any request.
{% endhint %}

## Next steps

* Use [Collection](https://v2.dataos.info/consume/activate/apis/collection.md) to test requests in Postman.
* Use [SDK](https://v2.dataos.info/consume/activate/apis/sdk.md) when you want typed clients instead of raw HTTP calls.
* Use [Data application](https://v2.dataos.info/consume/activate/apis/data-application.md) to register an application built on the Data Product.

***

## Reference

For full endpoint specifications, request/response schemas, query patterns, and deeper API concepts, see the [Data Product API reference](https://v2.dataos.info/references/interfaces/apis/data-product-apis/api-reference) in References.


---

# 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/consume/activate/apis.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.
