# Platinur

> Documentation for Platinur — the analytics engineering control plane for ClickHouse, dbt, Evidence, Prefect, and GitHub.

## Docs

- [API Reference](https://docs.platinur.com/api/overview.md): Control-plane API documentation generated from FastAPI OpenAPI.
- [Api Agent Task](https://docs.platinur.com/api/reference/assistant/api-agent-task.md)
- [Api Agent Task Create](https://docs.platinur.com/api/reference/assistant/api-agent-task-create.md)
- [Api Agent Task Create](https://docs.platinur.com/api/reference/assistant/api-agent-task-create-1.md)
- [Api Agent Task Diff](https://docs.platinur.com/api/reference/assistant/api-agent-task-diff.md)
- [Api Agent Task Logs](https://docs.platinur.com/api/reference/assistant/api-agent-task-logs.md)
- [Api Agents Chat](https://docs.platinur.com/api/reference/assistant/api-agents-chat.md)
- [Api Agents Chat Clear](https://docs.platinur.com/api/reference/assistant/api-agents-chat-clear.md)
- [Api Assistant Chat](https://docs.platinur.com/api/reference/assistant/api-assistant-chat.md)
- [Api Assistant Task](https://docs.platinur.com/api/reference/assistant/api-assistant-task.md)
- [Api Assistant Task By Client Request](https://docs.platinur.com/api/reference/assistant/api-assistant-task-by-client-request.md)
- [Api Assistant Task Events](https://docs.platinur.com/api/reference/assistant/api-assistant-task-events.md)
- [Api Assistant Task Logs](https://docs.platinur.com/api/reference/assistant/api-assistant-task-logs.md)
- [Api Environment Activate](https://docs.platinur.com/api/reference/configuration/api-environment-activate.md)
- [Api Environments](https://docs.platinur.com/api/reference/configuration/api-environments.md)
- [Api Github Deploy](https://docs.platinur.com/api/reference/configuration/api-github-deploy.md)
- [Api Github Initialize](https://docs.platinur.com/api/reference/configuration/api-github-initialize.md)
- [Api Github Status](https://docs.platinur.com/api/reference/configuration/api-github-status.md)
- [Api Github Sync](https://docs.platinur.com/api/reference/configuration/api-github-sync.md)
- [Api Status](https://docs.platinur.com/api/reference/configuration/api-status.md)
- [Api File](https://docs.platinur.com/api/reference/control-plane/api-file.md)
- [Api Initial Build Run](https://docs.platinur.com/api/reference/control-plane/api-initial-build-run.md)
- [Api Initial Build Status](https://docs.platinur.com/api/reference/control-plane/api-initial-build-status.md)
- [Api Notifications Test](https://docs.platinur.com/api/reference/control-plane/api-notifications-test.md)
- [Api Onboarding Save](https://docs.platinur.com/api/reference/control-plane/api-onboarding-save.md)
- [Bootstrap Start](https://docs.platinur.com/api/reference/control-plane/bootstrap-start.md)
- [Install Plan](https://docs.platinur.com/api/reference/control-plane/install-plan.md)
- [Api Dashboards Sync](https://docs.platinur.com/api/reference/dashboards/api-dashboards-sync.md)
- [Api Evidence Rebuild](https://docs.platinur.com/api/reference/dashboards/api-evidence-rebuild.md)
- [Api Evidence Run](https://docs.platinur.com/api/reference/dashboards/api-evidence-run.md)
- [Api Connector Pack Enable](https://docs.platinur.com/api/reference/integrations/api-connector-pack-enable.md)
- [Api Connector Pack Request](https://docs.platinur.com/api/reference/integrations/api-connector-pack-request.md)
- [Api Connector Packs](https://docs.platinur.com/api/reference/integrations/api-connector-packs.md)
- [Api Integration Create](https://docs.platinur.com/api/reference/integrations/api-integration-create.md)
- [Api Integration Delete](https://docs.platinur.com/api/reference/integrations/api-integration-delete.md)
- [Api Integration Run](https://docs.platinur.com/api/reference/integrations/api-integration-run.md)
- [Api Integration Run Detail](https://docs.platinur.com/api/reference/integrations/api-integration-run-detail.md)
- [Api Integration Run Logs](https://docs.platinur.com/api/reference/integrations/api-integration-run-logs.md)
- [Api Integration Scan](https://docs.platinur.com/api/reference/integrations/api-integration-scan.md)
- [Api Integration Test](https://docs.platinur.com/api/reference/integrations/api-integration-test.md)
- [Api Integration Test Draft](https://docs.platinur.com/api/reference/integrations/api-integration-test-draft.md)
- [Api Integration Update](https://docs.platinur.com/api/reference/integrations/api-integration-update.md)
- [Api Integrations](https://docs.platinur.com/api/reference/integrations/api-integrations.md)
- [Api Orchestration Run](https://docs.platinur.com/api/reference/monitoring/api-orchestration-run.md)
- [Api Run Detail](https://docs.platinur.com/api/reference/monitoring/api-run-detail.md)
- [Api Dbt Run](https://docs.platinur.com/api/reference/operations/api-dbt-run.md)
- [Api Dbt Run Assistant Fix](https://docs.platinur.com/api/reference/operations/api-dbt-run-assistant-fix.md)
- [Api Dbt Run Logs](https://docs.platinur.com/api/reference/operations/api-dbt-run-logs.md)
- [Api Dbt Run Start](https://docs.platinur.com/api/reference/operations/api-dbt-run-start.md)
- [Api Dbt Runs](https://docs.platinur.com/api/reference/operations/api-dbt-runs.md)
- [Api Model Catalog](https://docs.platinur.com/api/reference/operations/api-model-catalog.md)
- [Api Model Explain](https://docs.platinur.com/api/reference/operations/api-model-explain.md)
- [Api Model Lineage](https://docs.platinur.com/api/reference/operations/api-model-lineage.md)
- [Api Models Catalog Refresh](https://docs.platinur.com/api/reference/operations/api-models-catalog-refresh.md)
- [Api Promotions Create Pr](https://docs.platinur.com/api/reference/promotions/api-promotions-create-pr.md)
- [Api Promotions Current](https://docs.platinur.com/api/reference/promotions/api-promotions-current.md)
- [Api Promotions Deploy Prod](https://docs.platinur.com/api/reference/promotions/api-promotions-deploy-prod.md)
- [Api Promotions Discard Proposal](https://docs.platinur.com/api/reference/promotions/api-promotions-discard-proposal.md)
- [Api Promotions Discard Staging](https://docs.platinur.com/api/reference/promotions/api-promotions-discard-staging.md)
- [Api Promotions Stage Batch](https://docs.platinur.com/api/reference/promotions/api-promotions-stage-batch.md)
- [Api Promotions Stage Preview](https://docs.platinur.com/api/reference/promotions/api-promotions-stage-preview.md)
- [Api Promotions Sync](https://docs.platinur.com/api/reference/promotions/api-promotions-sync.md)
- [Api Promotions Unapply Staging](https://docs.platinur.com/api/reference/promotions/api-promotions-unapply-staging.md)
- [Api Proposal Apply](https://docs.platinur.com/api/reference/promotions/api-proposal-apply.md)
- [Api Proposal Assistant Fix](https://docs.platinur.com/api/reference/promotions/api-proposal-assistant-fix.md)
- [Api Proposal Deploy](https://docs.platinur.com/api/reference/promotions/api-proposal-deploy.md)
- [Api Proposal Files Text](https://docs.platinur.com/api/reference/promotions/api-proposal-files-text.md)
- [Api Proposal Open Pr](https://docs.platinur.com/api/reference/promotions/api-proposal-open-pr.md)
- [Api Proposal Reject](https://docs.platinur.com/api/reference/promotions/api-proposal-reject.md)
- [Api Proposal Review](https://docs.platinur.com/api/reference/promotions/api-proposal-review.md)
- [Api Proposal Validate](https://docs.platinur.com/api/reference/promotions/api-proposal-validate.md)
- [Api Schedule Apply](https://docs.platinur.com/api/reference/scheduling/api-schedule-apply.md)
- [Api Schedule Cron Translate](https://docs.platinur.com/api/reference/scheduling/api-schedule-cron-translate.md)
- [Api Schedule Pause](https://docs.platinur.com/api/reference/scheduling/api-schedule-pause.md)
- [Api Schedule Resume](https://docs.platinur.com/api/reference/scheduling/api-schedule-resume.md)
- [Api Schedule Run Now](https://docs.platinur.com/api/reference/scheduling/api-schedule-run-now.md)
- [Api Schedule Save](https://docs.platinur.com/api/reference/scheduling/api-schedule-save.md)
- [Api Account Password](https://docs.platinur.com/api/reference/settings/api-account-password.md)
- [Api User Create](https://docs.platinur.com/api/reference/settings/api-user-create.md)
- [Api User Reset Password](https://docs.platinur.com/api/reference/settings/api-user-reset-password.md)
- [Api User Update](https://docs.platinur.com/api/reference/settings/api-user-update.md)
- [Api Users](https://docs.platinur.com/api/reference/settings/api-users.md)
- [Assistant Proposals](https://docs.platinur.com/assistant/proposals.md): How the Assistant creates validated dbt and Evidence changes.
- [Access Control](https://docs.platinur.com/configuration/access-control.md): Portal users, roles, permissions, and audit ownership.
- [Backup and Restore](https://docs.platinur.com/configuration/backup-restore.md): Back up Platinur state with the platinur CLI and verify restores actually work.
- [Data Boundary](https://docs.platinur.com/configuration/data-boundary.md): What Platinur sends to the AI provider, and how to restrict it to schema and statistics only.
- [Notifications](https://docs.platinur.com/configuration/notifications.md): Deliver run failures, proposal events, production deploys, and schema drift to Slack, a webhook, or email.
- [Configuration](https://docs.platinur.com/configuration/settings.md): Configure GitHub, Assistant, connector packs, and environments.
- [Dashboards](https://docs.platinur.com/dashboards/evidence.md): Evidence dashboard previews and rebuild behavior.
- [Staging and Prod](https://docs.platinur.com/environments/staging-prod.md): The two-environment model used by Platinur.
- [Architecture Overview](https://docs.platinur.com/get-started/architecture.md): How the Platinur services fit together in a customer-hosted deployment.
- [First Setup Checklist](https://docs.platinur.com/get-started/first-setup.md): The recommended order for bringing a Platinur pilot online.
- [Installation](https://docs.platinur.com/get-started/installation.md): Install Platinur from the packaged installer: versioned Docker images plus the platinur CLI.
- [What is Platinur?](https://docs.platinur.com/index.md): Platinur is a customer-hosted analytics engineering control plane for ClickHouse, dbt, Evidence, Prefect, GitHub, and AI-assisted change management.
- [Runs, Logs, and Audit](https://docs.platinur.com/monitoring/runs-audit.md): Use Monitoring as the operational truth for Platinur runtime activity.
- [Data Model](https://docs.platinur.com/operations/data-model.md): Inspect dbt layers, files, and tests in Operations.
- [Failure Recovery](https://docs.platinur.com/operations/failure-recovery.md): Recover from a failed refresh using schema drift detection and an assistant repair proposal.
- [Initial Run](https://docs.platinur.com/operations/initial-run.md): Generate the first validated dbt model proposal from selected source schemas and tables.
- [Promotions](https://docs.platinur.com/promotions/release-flow.md): Move validated staged changes toward production through GitHub.
- [Scheduling](https://docs.platinur.com/scheduling/schedules.md): Schedule source loads and dbt model runs.
- [Connector Packs](https://docs.platinur.com/sources/connector-packs.md): How Platinur handles source connectors that require extra worker packages.
- [External ClickHouse Setup](https://docs.platinur.com/sources/external-clickhouse-setup.md): Run Platinur against your own ClickHouse cluster or ClickHouse Cloud instead of the bundled server.
- [External ClickHouse Schemas](https://docs.platinur.com/sources/external-schemas.md): How Platinur works with source data loaded outside Platinur.
- [Platinur Integrations](https://docs.platinur.com/sources/integrations.md): Configure and test dlt-powered source loads into ClickHouse.
- [Source Load Modes](https://docs.platinur.com/sources/load-modes.md): Replace, append, and incremental source-load behavior.
- [Table Selection](https://docs.platinur.com/sources/table-selection.md): Use all tables or selected tables for source loading and Initial Run.

## OpenAPI Specs

- [openapi](https://docs.platinur.com/api/openapi.json)