Preservica Python API Docs | dltHub

Preservica provides a suite of REST APIs for managing, searching, and accessing digital content within the Preservica system. The REST API base URL is https://<server_name>.preservica.com and Requests require a 'Preservica-Access-Token' header containing a valid access token obtained from the Access Token API..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Preservica data in under 10 minutes.

---

What data can I load from Preservica?

Here are some of the endpoints you can load from Preservica:

---

How do I authenticate with the Preservica API?

Authentication is achieved by first requesting an access token from the Access Token API, which is then used as a custom header in subsequent requests. The required header is 'Preservica-Access-Token' with the token string as the value.

1. Get your credentials

Preservica does not use static API keys in the traditional sense. Instead, it uses a token-based authentication system. To obtain access credentials: 1. Identify your Preservica tenant URL (e.g., https://your-tenant.preservica.com). 2. Use a valid Preservica username and password for a user account with appropriate API permissions. 3. Send a POST request to the /api/accesstoken/login endpoint of your instance. 4. Include your credentials (username, password, and tenant) as x-www-form-urlencoded parameters in the request body. 5. The API will return a JSON object containing an token (the access token) and a refresh-token. 6. Use the token in the 'Preservica-Access-Token' HTTP header for all subsequent API requests. The token is time-limited (typically 15 minutes) and must be refreshed using the /api/accesstoken/refresh endpoint or by re-authenticating.

2. Add them to .dlt/secrets.toml

Copy
[sources.preservica_source]
preservica_url = "https://your-tenant.preservica.com"
preservica_username = "your_username"
preservica_password = "your_password"
preservica_tenant = "your_tenant_id"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Preservica API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
uv run python preservica_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline preservica_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset preservica_data
The duckdb destination used duckdb:/preservica.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads /api/accesstoken/login and /api/accesstoken/refresh from the Preservica API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def preservica_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<server_name>.preservica.com",
            "auth": {"type": "bearer", "token": access_token},
        },
        "resources": [
            {"name": "collections", "endpoint": {"path": "api/entity/collections"}},
            {"name": "search", "endpoint": {"path": "api/content/search"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="preservica_pipeline",
        destination="duckdb",
        dataset_name="preservica_data",
    )
    load_info = pipeline.run(preservica_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("preservica_pipeline").dataset()
sessions_df = data.search.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM preservica_data.search LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("preservica_pipeline").dataset()
data.search.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Preservica data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack