Introduction

Welcome to the technical documentation for the InsightSolver API Client.

About InsightSolver

InsightSolver is a SaaS (Software as a Service) solution designed for advanced rule mining and data insights. Powered by a centralized rule-mining engine, it enables organizations to uncover hidden patterns and generate actionable insights for data-driven decision-making.

Access Options

InsightSolver can be accessed through the following options:

• The InsightSolver API Client, designed for seamless integration with Python applications and data workflows.

• The InsightSolver Web App, which provides an intuitive and interactive interface for exploring rule-mining results, visualization, and analysis.

This documentation specifically covers the InsightSolver API Client. The InsightSolver Web App will have its own documentation once available.

The InsightSolver API client

The InsightSolver API Client offers a Python-based interface for direct interaction with our rule-mining engine. Designed for data engineers, scientists, and developers, this client integrates InsightSolver’s functionalities into custom workflows, applications, and automated pipelines. The API client allows users to configure rule-mining parameters, send encrypted data to the server and retrieve results efficiently.

Who Should Use This Documentation?

This documentation is for:

• Developers integrating our rule-mining API.

• Engineers needing setup guides and technical references.

• Users looking for examples of effective API use.

Accessing the API

To use the InsightSolver API, you need the following:

• A valid service key This is a .json file that authenticates your identity and secures communication with the InsightSolver API server.

• Available credits API usage is metered based on the size of your dataset. See the Credits section for more details on how credits are calculated and usage tips.

To request a service key and/or obtain additional credits, please contact us at support@insightsolver.com.