> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paradime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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:

```bash theme={"system"}
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.

<Info>
  Bearer-token authentication (account and workspace API keys) requires **`paradime-io` version 5.13.0 or later**.
</Info>

<Card title="Generate Api Keys Legacy" href="/developers/generate-api-keys-legacy" horizontal icon="arrow-right" />

### 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.

<Tabs>
  <Tab title="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).

    ```python theme={"system"}
    from paradime import Paradime

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

    <Info>
      `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.
    </Info>
  </Tab>

  <Tab title="Workspace API Key [legacy]">
    Legacy workspace API keys use an `API Key` and `API Secret` pair:

    ```python theme={"system"}
    from paradime import Paradime

    paradime = Paradime(
        api_endpoint="API_ENDPOINT",
        api_key="API_KEY",
        api_secret="API_SECRET",
    )
    ```
  </Tab>
</Tabs>

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:

<Card title="Audit Log" href="/developers/python-sdk/modules/audit-log" horizontal icon="arrow-right" />

<Card title="Bolt" href="/developers/python-sdk/modules/bolt" horizontal icon="arrow-right" />

<Card title="Custom Integration" href="/developers/python-sdk/modules/custom-integration" horizontal icon="arrow-right" />

<Card title="Compare Lineage Version" href="/products/data-catalog/lineage/compare-lineage-version" horizontal icon="arrow-right" />

<Card title="User Management" href="/developers/python-sdk/modules/user-management" horizontal icon="arrow-right" />

<Card title="Workspace Management" href="/developers/python-sdk/modules/workspace-management" horizontal icon="arrow-right" />


## Related topics

- [Getting Started](/developers/webhooks/getting-started.md)
- [Paradime Setup and Configuration](/integrations/pre-commit/paradime-setup-and-configuration.md)
- [Copilot](/products/dino-ai/copilot/index.md)
- [Create Azure DevOps Items](/products/bolt/creating-schedules/templates/ticketing-templates/create-azure-devops-items.md)