# 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 obtain the following API credentials for your workspace:

* `API Key`
* `API Secret`
* `API Endpoint`

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

## Initialize the Python SDK

Once you have your API credentials, you can initialize the Paradime SDK client:

```python
from paradime import Paradime

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

# Now you can use the paradime client to interact with the API
```

Replace `"API_ENDPOINT"`, `"API_KEY"`, and `"API_SECRET"` with your actual credentials.

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

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

The question should be specific, self-contained, and written in natural language.
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.