Getting Started

Introduction

The Paradime SDK provides a convenient way to interact with the Paradime API, allowing you to manage various aspects of your Paradime workspace programmatically.

This documentation will guide you through the installation process, basic usage, and specific features of the SDK.

Installation

To install the Paradime SDK, use pip:

pip install paradime-io

Obtaining API Credentials

Before you can use the Paradime SDK, you need to generate an API key and copy its API Endpoint. The SDK supports both key types — see API Keys to generate one.

Bearer-token authentication (account and workspace API keys) requires paradime-io version 5.13.0 or later.

API Keys

Initialize the Python SDK

Once you have your credentials, initialize the Paradime SDK client. How you initialize it depends on the type of API key you generated.

Account API Key

Account API keys use a Bearer token (starting with prdm_cmp_). Pass it as api_secret and set workspace_uid to the workspace the SDK should run against (the workspace_token from Account Settings → Workspace).

from paradime import Paradime

paradime = Paradime(
    api_endpoint="API_ENDPOINT",
    api_secret="prdm_cmp_...",   # your account API key
    workspace_uid="WORKSPACE_UID",
)

workspace_uid is required for account API keys. To target a different workspace, use the same key and change workspace_uid — the key must have been granted access to that workspace.

Workspace API Key [legacy]

Replace the placeholder values with your actual credentials. You can now use the paradime client to interact with the API.

SDK Modules

The following docs provide detailed information and usage examples for each of the Paradime SDK modules:

Audit LogBoltCustom IntegrationCompare Lineage versionUser ManagementWorkspace Management