Reference
Advanced API Reference
Use the generated API reference after the authored docs have oriented you to the right feature area.
The generated API reference is the source of truth for request and response detail. Use this page to choose the right endpoint group before diving into operation-level pages.
Best Entry Points
- Platform Features for capability discovery
- Generated API Reference for complete operation and schema detail
Recommended Starting Groups
| Need | Start here |
|---|---|
| Query execution | Queries Endpoint Index |
| Identity and access | Identity Endpoint Index and Auth Endpoint Index |
| Catalog and object management | Catalogs Endpoint Index |
| Data products | Products Endpoint Index |
| Asset orchestration | Assets Endpoint Index |
| Transformations and macros | Models Endpoint Index |
| Notebooks and job execution | Notebooks Endpoint Index |
| Pipelines and orchestration jobs | Pipelines Endpoint Index |
| Semantics and metrics | Semantic Layer Endpoint Index |
| Lineage and impact | Lineage Endpoint Index |
| Data load and storage | Storage Endpoint Index |
| Remote execution | Compute Endpoint Index |
Where To Start
| Need | Start With | Why |
|---|---|---|
| Exact paths, parameters, and payloads | Generated API reference | It is the source of truth for operation detail |
| Operation IDs for automation or codegen | Generated API reference | It exposes the precise operation surface |
| Access-surface choices | Product guides | They explain the user and platform workflow first |
| Access-policy design | Product guides | They teach the governance model, not just endpoints |
| Builder workflow selection | Product guides | They connect endpoints to a real end-to-end path |
| Runtime and operations questions | Product guides | They explain safe deployment and troubleshooting decisions |