Introduction
The Steep API lets you take the logic and structure you define in Steep and use it outside the product. You can retrieve metadata, query trusted metrics and entity rows via Steep’s query engine, and control semantic-layer syncs for supported integrations.
Available endpoints
| Endpoint | Description |
|---|---|
/v1/metrics | List all metrics in the metric catalog. |
/v1/metrics/search | Search metrics by keywords. |
/v1/metrics/{metricId} | Get a single metric by id. |
/v1/metrics/{metricId}/query | Query a specific metric using Steep’s query engine and return aggregated results and SQL query. |
/v1/entities | List entities with basic metadata such as name and module. |
/v1/entities/{entityId} | Get a single entity by id, including its properties, primary key, and linked metrics. |
/v1/entities/{entityId}/query | Query rows of an entity, with optional property filters, sorting, and a row limit. |
/v1/modules | List modules, including label, description, identifier, and table and schema information. |
/v1/workspace/members | List workspace members, including name, email, and role. |
/v1/workspace/teams | List teams, including name, description, and members, or create a new team. |
/v1/workspace/teams/{id} | Get, update, or delete a single team by id. |
/semantic-layer-syncs | Deprecated. Triggers a semantic layer sync for dbt and Cube integrations. Use /v1/code/syncs instead. |
/v1/code/syncs | Sync your semantic models (Steep as code, dbt or Cube) into Steep. Set dryRun: true to preview what a sync would create, update or remove without changing anything. For Steep as code, a dry run can include your YAML files to preview local changes before pushing them. |
/v1/code/syncs/{id} | Get the current state of a sync by id. Use it to check whether a sync has completed or failed. |
/v1/code/validate | Send Steep YAML files to check their structure and references before syncing. |
/v1/code/schema | The JSON Schema for Steep YAML files, used by editors for autocomplete and validation. |
/v1/code/schema/module | The JSON Schema for a Steep YAML module file. |
/v1/code/schema/targets | The JSON Schema for a Steep YAML targets file. |
/v1/targets | List all target series and their metrics for your workspace. |
/v1/targets/query | Query time-series target data for a metric and series. |
/v1/reports | List reports in the workspace, or create a new report. Creating a report requires a signed-in user and cannot be done via API key. |
/v1/reports/search | Search reports by title and content. |
/v1/reports/{id} | Get a single report by id, including its full contents. |
/v1/usage/metrics | List usage metrics: metrics Steep provides about how your workspace uses Steep, such as active members and query volume. Needs an admin or an API key with the usage-metrics:read scope. |
/v1/usage/metrics/{usageMetricId}/query | Query a usage metric's values over time, with optional breakdowns and filters. Also needs the usage-metric-queries:read scope. |
API authentication
All requests to the Steep API must be authenticated using an API key.
To create an API key:
- Go to Settings → API
- Click Create API key.
- Select when you want the key to expire.
- Select the scopes the key needs.
- Generate key
- Copy the key.
API keys are only shown once when created. Store them securely.
To authenticate a request to the Steep API, send the API key in the Authorization header of the request, prefixed with ApiKey.
Authorization: ApiKey <your API key>
An API key acts for the workspace, not for a person
A request made with an API key isn't tied to any member, so member-level access doesn't apply to it. Within its scopes, a key reads like a workspace admin:
- Every metric, including private ones.
- Every data row. Access policies don't filter what it reads.
- Every team, including private teams and their members, and every workspace member's name and email.
Reports are the exception. A key only sees reports shared with the whole workspace, and it can't create reports.
With scopes that write, a key can change things as an admin would, such as editing or deleting any team, including private ones.
The key's scopes are its only limit. It doesn't depend on who created it: it keeps working after that person leaves the workspace, and nothing it changes is attributed to a person. Give each key only the scopes it needs, and set an expiry. When each person should see only what they have access to in Steep, have them connect through the MCP server instead, which signs each person in.
API key expiration
API keys do not expire by default. They can be revoked at any time from Settings → API.
If an API key is lost or compromised, revoke it and generate a new one.