Welcome to CredVault

CredVault is the control plane for your data platform and developer platform. It brings together managed database clusters, API access, automation, AI workflows, cloud development environments, and Pragma IDE downloads in one product surface.

The goal is simple: a user should be able to sign in, create a secure data workspace, connect an application, automate work around the data, and build from the browser, terminal, or desktop IDE without stitching together many separate tools.

Product Map

AreaWhat users doWhere it lives
Database platformCreate clusters, collections, documents, rules, backups, scaling, and maintenance windowsDashboard -> Clusters
API platformCreate API keys, call REST endpoints, manage scopes, test requestsDashboard -> API Keys and /api-docs
CIEUpload datasets, train models, deploy models, run SQL, use terminal workflowscie CLI and /api/cie
AutomationRun functions, triggers, webhooks, pipelines, migrations, and scheduled workflowsCluster actions, Functions, Webhooks, Migrations
ObservabilityView metrics, activity logs, alerts, dashboards, service health, and usageMonitoring, Logs, Billing
Data toolsUse notebooks, ML experiments, orchestration, lineage, metadata, and visualization toolsCredVault notebooks, experiments, orchestration, lineage, metadata, and realtime visualization
Developer toolsOpen Coder cloud workspaces and install Pragma IDECoder and Download pages

How The Platform Fits Together

Most user workflows follow the same path:

  1. A user signs in through CredVault authentication.
  2. CredVault creates or finds the user's tenant/workspace.
  3. The user creates a database cluster.
  4. The backend stores cluster metadata and provisions access.
  5. The user creates an API key or uses a session token.
  6. Applications, SDKs, the dashboard, and the cie CLI call the same backend APIs.
  7. Activity logs, billing usage, and security checks run around those requests.

That means the dashboard and CLI are not separate products. They are two ways to control the same CredVault backend.

What Users Can Build

Database Applications

Use CredVault like a managed document database. Create collections, insert JSON documents, query data, apply access rules, and expose controlled access through API keys.

Test it from the API explorer:

Example
Test in API explorer
Open /api-docs
Authorize with a Bearer token or API key
Try GET /api/clusters
Try GET /api/data/clusters/{clusterId}/collections

Automation Around Data

Use functions and webhooks to react when something changes. A common flow is:

Example
Document inserted -> webhook delivery -> external system receives event
Document inserted -> trigger/function -> custom backend logic runs
Pipeline scheduled -> data transformed -> logs recorded

AI And ML Workflows

Use CIE from the terminal:

Terminal
npm install -g credvault-cie
cie login
cie data upload ./customers.csv
cie train <dataset-id> --name "Churn Model" --type classification
cie jobs status <job-id>
What you should seeA browser login prompt or terminal confirmation that your CredVault session is active.

Developer Workspaces

Use Coder when a developer needs a browser-accessible development environment with terminal access, workspace templates, and IDE integrations. Use Pragma when a user wants the desktop IDE experience.

What Is Actually User-Facing

The documentation in this section focuses on things a user can directly see or use:

  • Dashboard pages such as Clusters, API Keys, Billing, Logs, Monitoring, Migrations, and Downloads
  • CLI commands such as cie login, cie data upload, cie jobs status, and cie billing status
  • REST APIs available through the backend and /api-docs
  • Integrated tools such as Coder, Pragma, experiments, orchestration, lineage, metadata, and realtime visualization

When a feature depends on an external service being configured, the docs call that out. For example, experiments, orchestration, lineage, metadata, realtime visualization, and robotics integrations rely on service URLs and proxy routes being available in the backend.

Start Here

  1. Create an account at Sign up.
  2. Open the dashboard and create a database cluster.
  3. Create an API key from API Keys.
  4. Open REST API and test an endpoint in /api-docs.
  5. Install the CIE CLI with npm install -g credvault-cie.
  6. Read Database Clusters, API Keys, and CIE CLI.

For Developers

Use these paths when you want to test from your machine:

Terminal
# Install the terminal tool
npm install -g credvault-cie

# Log in to CredVault
cie login

# Check your account
cie whoami

# Test platform health
cie doctor
What you should seeA browser login prompt or terminal confirmation that your CredVault session is active.

Use these paths when you want to test from the browser:

Example
Test in API explorer
/api-docs              Interactive API explorer
/cluster               Database clusters
/api-keys              API key management
/logs                  Activity logs
/billing               Plan, usage, invoices, and payment methods
/download              Pragma IDE installers

Documentation Standards

Every strong CredVault doc should answer four questions:

  1. What does the feature do?
  2. Where does the user click?
  3. What API or CLI command is behind it?
  4. How can the user test that it works?

The next pages follow that structure.