Introduction

The Aignostics Platform runs computational pathology applications — such as HETA, which analyzes the tumor microenvironment in H&E-stained tissue — on your whole slide images. The Aignostics Python SDK is how you work with it, through the interfaces below.

Choose your interface

Choose your preferred interface for working with the Aignostics Platform: Console if you want to work in your browser, the Python Library or REST API if you want to integrate the Platform into your own code.

🌐 Console (Web Interface)

What it is

Web interface at platform.aignostics.com for creating and monitoring analyses in your browser, combined with a single Python SDK command to upload your slides

Best for

Pathologists and researchers who prefer working in a browser and want the least software to install

Use when

Analyzing slides that are already on your computer or file server (1-100s of slides), without installing a desktop application

Get started

Get started with Console

📚 Python Library

What it is

Python library for programmatic access in scripts, notebooks, and applications

Best for

Data scientists and developers who want to integrate the platform into Python-based workflows

Use when

Building custom analysis pipeline in Python for repeated usage and processing large datasets (10s-1000s of slides)

Get started

Get started with the Python Library

🔌 REST API (Direct HTTP)

What it is

The Platform’s REST API at https://platform.aignostics.com/api/v1, called directly over HTTPS

Best for

Developers integrating from another language or an existing pipeline, without depending on the Python SDK

Use when

Building a service or workflow outside Python, or generating your own client from the OpenAPI document

Get started

Get started with the API

💡 Each interface has its own step-by-step guide (linked above) that includes installation. Console handles authentication for you; the Python Library and API guides cover credential setup.

Next Steps

The best next step is to run your first analysis end to end.

New here? Start with the Get started with Console guide — it walks you through signing up, uploading your slides, and running HETA on them in your browser, with no coding required. Prefer to work in code? Use the Get started with the Python Library or Get started with the API guide instead.

Once you’ve run your first analysis: