Mindtickle Python API Docs | dltHub

Mindtickle is a learning enablement platform that provides content, user, and reporting APIs for enterprise integration. The REST API base URL is https://api.mindtickle.com and All requests require a JWT Bearer token in the Authorization header..

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 pip install "dlt[workspace]" and start loading Mindtickle data in under 10 minutes.

---

What data can I load from Mindtickle?

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

---

How do I authenticate with the Mindtickle API?

Authentication uses a JWT signed with your Secret Key; the token is sent as Authorization: Bearer <jwt> where the payload includes iss (API Key), aud (Client ID), iat, exp, and jti.

1. Get your credentials

1. Log in to the Mindtickle admin console.
2. Navigate to Settings → API Access (or Integrations).
3. Click Generate New Credentials to obtain an API Key and Secret Key.
4. Contact support@mindtickle.com to request the Client ID required for JWT generation.
5. Store the three values securely for use in the dlt pipeline.

2. Add them to .dlt/secrets.toml

Copy
[sources.mindtickle_source]
api_key = "your_api_key_here"
secret_key = "your_secret_key_here"
client_id = "your_client_id_here"

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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt 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
dlt ai toolkit rest-api-pipeline install

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 Mindtickle 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
python mindtickle_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline mindtickle_pipeline 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 group and user from the Mindtickle 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 mindtickle_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.mindtickle.com",
            "auth": {
                "type": "bearer",
                "token": api_key,
            },
        },
        "resources": [
            {"name": "group", "endpoint": {"path": "services/data/v2.0/mtobjects/Group/{groupid}"}},
            {"name": "user", "endpoint": {"path": "services/data/v2.0/mtobjects/User/{userid}"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="mindtickle_pipeline",
        destination="duckdb",
        dataset_name="mindtickle_data",
    )
    load_info = pipeline.run(mindtickle_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("mindtickle_pipeline").dataset()
sessions_df = data.group.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM mindtickle_data.group LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("mindtickle_pipeline").dataset()
data.group.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 Mindtickle 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.

---

Troubleshooting

Authentication Errors

• 401 Unauthorized – Occurs when the JWT is missing, malformed, or signed with an incorrect Secret Key. Ensure the token is generated with the proper API Key, Secret Key, and Client ID, and that it is not older than 1 hour.

Rate Limiting

• 429 Too Many Requests – Mindtickle enforces a limit of 4 requests per second and 60 requests per minute per account. If this limit is exceeded, back‑off and retry after a short delay.

Token Expiry

• 403 Forbidden (or 401) may also be returned when the JWT exp claim exceeds the 1‑hour maximum. Regenerate the token before it expires.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

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

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

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• 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