> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dqlabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> What the Prizm REST API covers, how it's organized, and where to go next.

<script type="application/ld+json">
  {`{
            "@context": "https://schema.org",
            "@type": "TechArticle",
            "headline": "API Overview",
            "description": "What the Prizm REST API covers, how it's organized, and where to go next.",
            "url": "https://docs.dqlabs.ai/api-reference/overview",
            "publisher": {
              "@type": "Organization",
              "name": "DQLabs Inc",
              "logo": "https://media.brand.dev/332adc35-5bc4-4d2b-bf78-256aa4a5e414.svg"
            }
            }`}
</script>

The Prizm REST API gives you programmatic access to the same data your organization manages in the Prizm UI — assets, metrics, alerts, issues, sources, schedules, and governance entities like domains, glossaries, and tags.

<Note>
  This reference is in active development. Endpoint paths, methods, and groupings below are confirmed against the current API. Response field-level schemas are confirmed for 68 of 156 operations so far, captured directly from a live QA environment — every read (`GET`/`list`) operation reachable from existing records. The remaining operations are write actions (create/update/delete, intentionally not exercised against live data) or reads with no existing records to capture from yet; those pages say so explicitly rather than guessing at fields.
</Note>

## Base URL

Every request is made against your organization's Prizm workspace host:

```text theme={null}
https://<your-workspace>.prizmdata.ai/api/v1/...
```

Replace `<your-workspace>` with your organization's subdomain — the same host you use to sign in to Prizm.

## Services

The API is organized into seven services, each with its own path prefix:

| Service      | Path prefix            | Covers                                                                 |
| :----------- | :--------------------- | :--------------------------------------------------------------------- |
| Core         | `/api/v1/core`         | Assets, sources, documents, lineage, conversations, cost & performance |
| Metrics      | `/api/v1/metrics`      | Metrics, metric templates, alerts, alert clusters, issues, parameters  |
| Governance   | `/api/v1/governance`   | Domains, glossaries, terms, tags, categories, products, applications   |
| Schedule     | `/api/v1/schedule`     | Scheduling and event triggers for metric runs and pipelines            |
| Integrations | `/api/v1/integration`  | Third-party connector configuration                                    |
| Notification | `/api/v1/notification` | Notification channels and delivery                                     |
| Logging      | `/api/v1/logging`      | Audit and activity logs                                                |

This reference currently covers Create / Get / List / Update / Delete operations for each resource — auxiliary actions, statistics, and reporting endpoints will be added over time.

## Before you start

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    Generate an API access token and see how to send it with every request.
  </Card>

  <Card title="Response & Error Format" icon="brackets-curly" href="/api-reference/response-format">
    Understand the response envelope and the list/filter pattern shared across endpoints.
  </Card>
</CardGroup>

## Making your first request

Every endpoint requires a bearer token (see [Authentication](/api-reference/authentication)). Here's a minimal example against a `list` endpoint:

```bash theme={null}
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/asset/list" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": { "page": 1, "pageSize": 10 },
    "sorting": [],
    "filters": [],
    "search": "",
    "export": false
  }'
```