SDK Platform Coverage

CredVault SDKs call the same backend as the dashboard and CIE. Use them from your own services and scripts — they are not a pixel-perfect clone of every UI screen.

Pick a door:

How The SDK Fits

Create a client and call resources such as data, cie, functions, webhooks, logs, plus platform helpers (notebooks, orchestration, lineage, metadata, pipelines, …) where your package version exposes them.

Best fits:

• backend services reading/writing CredVault data
• jobs that manage backups, functions, triggers, webhooks
• CIE model train/predict from application code
• CI scripts and workers

Workspace UIs (Notebook, ML Experiments, Orchestration, Lineage, Metadata, Omnigent, Team Management) stay dashboard-first; SDKs expose HTTP-capable pieces, not every visual screen.

Main Dashboard Areas

Current SDK Resource Map

The Node.js, Python, Go, and Java SDKs follow the same resource layout.

Platform Integration Examples

Node.js:

const jobs = await credvault.orchestration.listJobs();
const run = await credvault.orchestration.runJob("daily_customer_refresh");

const lineage = await credvault.lineage.getLineage({
  nodeId: "dataset:customers",
  depth: 3,
  direction: "DOWNSTREAM",
});

const tables = await credvault.metadata.search({ q: "customers" });
const execution = await credvault.pipelines.run("pipeline-id");
const dashboardData = await credvault.dashboards.data("dashboard-id");

Python:

jobs = client.orchestration.list_jobs()
run = client.orchestration.run_job("daily_customer_refresh")

lineage = client.lineage.get_lineage(
    node_id="dataset:customers",
    depth=3,
    direction="DOWNSTREAM",
)

tables = client.metadata.search("customers")
execution = client.pipelines.run("pipeline-id")
dashboard_data = client.dashboards.data("dashboard-id")

Java:

String jobs = client.platform.orchestration.listJobs();
String run = client.platform.orchestration.runJob("daily_customer_refresh");
String tables = client.platform.metadata.search("customers", 10);

Go:

jobs, err := cv.Orchestration.ListJobs()
run, err := cv.Orchestration.RunJob("daily_customer_refresh")
tables, err := cv.Metadata.Search("customers", 10)

Production Base URL

The SDK source defaults to a local development server:

http://localhost:5000/api

Production applications must pass the deployed CredVault backend API URL:

https://<your-credvault-backend>/api

If a production app does not set the base URL, it will try to call the user's own computer and the request will fail.

API Keys And User Tokens

CredVault uses two different credential types.

Use an API key when your backend service needs direct data access:

curl https://<your-credvault-backend>/api/v1/data/customers \
  -H "X-API-Key: <your-api-key>"

Use a user token when the action belongs to a signed-in dashboard user, such as managing clusters, functions, webhooks, API keys, logs, settings, or billing-related account state.

What Is Ready For SDK Use

These areas are the best fit for SDK-based development today:

• application data access through /api/v1/data
• cluster discovery through authenticated user sessions
• CIE datasets, model training, model listing, and predictions
• webhooks
• serverless functions
• triggers
• backups
• schema and indexes
• API key lifecycle operations
• metrics
• activity logs
• basic notifications
• orchestration jobs, runs, assets, sensors, and schedules
• lineage namespaces, datasets, jobs, runs, versions, search, and lineage graph queries
• metadata tables, databases, search, and metadata lineage
• CredVault notebook operations
• pipelines, dashboards, alerts, realtime stream management, and agent session/event calls

These are the features a developer building on CredVault should start with.

What Should Stay Dashboard Or REST API First

These areas are platform features, but they should not be presented as fully covered by the current SDKs yet:

• team and workspace member administration
• migrations and external connection testing
• billing, invoices, credits, and payment methods
• Pragma IDE
• advanced experiment tracking beyond the core SDK helpers

Users can still use these features in the dashboard or through documented REST APIs where available.

Recommended Wording For Users

Use this wording when describing the SDKs:

CredVault SDKs let developers build applications and automation on top of CredVault data, CIE, functions, webhooks, triggers, backups, schema, metrics, logs, API keys, notebooks, pipelines, dashboards, alerts, orchestration, lineage, metadata, realtime streams, and agent sessions.

Avoid saying:

The SDKs control every CredVault product and dashboard feature.

That would be inaccurate because some product areas are dashboard-first or integration-first today.

Choosing The Right Tool

The SDK should be presented as a developer acceleration layer for the stable core platform APIs. The dashboard remains the main place for broad platform management.