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 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. Use expanded=true to return full metric definitions. |
/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/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. |
/v1/semantic-layer-syncs | Automate or trigger a semantic layer sync for dbt and Cube integrations. |
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 to key to expire
- 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>
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.