> 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

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, then download the [Postman collection](/consume/activate/apis/collection.md) to start testing fast, or open the in-product **APIs documentation** for the full reference.

![Build on the APIs page showing the Postman collection and APIs documentation](/files/m3xAKGtw7QJVHHQuBxjZ)

{% 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 %}

![APIs documentation page showing the GraphQL endpoint with request body and response sample](/files/VJMysF8R08F2ELSsHTeD)

## Before you start

Before calling any endpoint:

{% stepper %}
{% step %}
Generate a [DataOS API token](/consume/get-started/readme-1.md#get-a-dataos-api-token).
{% endstep %}

{% step %}
Confirm the Data Product exposes [semantic models](/consume/understand/assets/semantics.md) if you plan to query data.
{% endstep %}

{% step %}
Validate the fields you need in [Query in Studio](/consume/understand/overview.md) or the GraphQL playground before you automate the call.
{% endstep %}
{% endstepper %}

## 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 before running any request.
{% endhint %}

## Next steps

* Use [Collection](/consume/activate/apis/collection.md) to test requests in Postman.
* Use [SDK](/consume/activate/apis/sdk.md) when you want typed clients instead of raw HTTP calls.

***

## Reference

For full endpoint specifications, request/response schemas, query patterns, and deeper API concepts, see the [Data Product API reference](/concepts/foundations/activation/apis.md).


---

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