> For the complete documentation index, see [llms.txt](https://docs.paradime.io/app-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.paradime.io/app-help/developers/python-sdk/getting-started.md).

# Getting Started

### Introduction <a href="#introduction" id="introduction"></a>

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

{% hint style="info" %}
Bearer-token authentication (account and workspace API keys) requires **`paradime-io` version 5.13.0 or later**.
{% endhint %}

{% content-ref url="/pages/ZsR10m0IstITtXbGOX9C" %}
[API Keys](/app-help/developers/generate-api-keys-legacy.md)
{% endcontent-ref %}

### 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
from paradime import Paradime

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

{% hint style="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.
{% endhint %}
{% endtab %}

{% tab title="Workspace API Key \[legacy]" %}
Legacy workspace API keys use an `API Key` and `API Secret` pair:

```python
from paradime import Paradime

paradime = Paradime(
    api_endpoint="API_ENDPOINT",
    api_key="API_KEY",
    api_secret="API_SECRET",
)
```

{% endtab %}
{% endtabs %}

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:

{% content-ref url="/pages/DnTNG0C2MgN1cg29iMWW" %}
[Audit Log](/app-help/developers/python-sdk/modules/audit-log.md)
{% endcontent-ref %}

{% content-ref url="/pages/DfMbhvTnGwkJi4xH0NaV" %}
[Bolt](/app-help/developers/python-sdk/modules/bolt.md)
{% endcontent-ref %}

{% content-ref url="/pages/MjTZaxoeuVjYNzWnGMJW" %}
[Custom Integration](/app-help/developers/python-sdk/modules/custom-integration.md)
{% endcontent-ref %}

{% content-ref url="/pages/nb43jNbA8n1WJNSbsbFD" %}
[Compare Lineage version](/app-help/documentation/data-catalog/lineage/compare-lineage-version.md)
{% endcontent-ref %}

{% content-ref url="/pages/4jcNaCn0vpw9LklBtLpo" %}
[User Management](/app-help/developers/python-sdk/modules/user-management.md)
{% endcontent-ref %}

{% content-ref url="/pages/3bKVPNjZCUirYIU2QVb0" %}
[Workspace Management](/app-help/developers/python-sdk/modules/workspace-management.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.paradime.io/app-help/developers/python-sdk/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.