Official SDKs

CredVault provides SDK package archives for Node.js, Python, Go, and Java. These are real SDKs, but the current distribution is through CredVault-provided package files or source archives unless your organization has published them to a private or public package registry.

The current SDK archives are:

The separate CIE CLI package remains the terminal tool:

npm install -g credvault-cie

Important Package Status

Use only confirmed package names and registry locations in production. The Node.js SDK package is credvault-edge, not credvault-sdk. The Python SDK package is credvault-edge, not credvault.

For now, SDK users should install from the package files or source archives provided by CredVault. When a package is published to a registry, update these docs with the public registry command.

What Users Can Use Today

Production Base URL

The SDK source currently defaults to a local development backend:

http://localhost:5000/api

That is correct for local backend testing only. Production users must pass the CredVault API base URL when creating the client:

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

If the base URL is not set, the SDK will try to call a backend running on the user's own computer and production requests will fail.

Authentication Scope

The SDKs support both API keys and signed-in user tokens, but they are not the same thing.

If an SDK method calls /api/v1/data, use an API key with the right data permissions. If a method calls dashboard/admin routes such as clusters, functions, API-key management, settings, or logs, use a signed-in user token.

Resources Included

The SDKs expose the same core platform areas:

• auth for user login and profile calls
• data for clusters and collection data
• cie for Intelligence Engine datasets, models, and predictions
• webhooks for event delivery configuration
• functions for serverless functions
• triggers for database event automation
• backups for backup and restore operations
• schema for schema and index operations
• apiKeys or api_keys for API key management
• metrics for monitoring data
• logs for activity and audit logs
• notifications for user notifications; preference methods should be checked against /api-docs
• settings for account and platform settings; some methods need backend route alignment before public use
• robots for robot and device endpoints, but this area needs route alignment before being documented as public-ready

Choosing An Integration Method

Use the REST API when building directly against HTTP:

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

Use an SDK when your application is written in Node.js, Python, Go, or Java and you want a language-native client.

For a feature-by-feature map of what the SDKs cover compared with the CredVault dashboard, see Platform Coverage.

Use the CIE CLI when working from a terminal:

cie login
cie data upload ./customers.csv
cie jobs list

Authentication Methods

Store tokens and API keys in environment variables or a secrets manager. Never commit them into source control.