Nikon Instruments Inc. | Americas

Return to the top of the page

NIS-Elements

Imaging Software

Seamless Scheduler Integration with the NIS‑Elements API

The NIS‑Elements API enables seamless integration of robotic systems, incubators, liquid handlers, and custom automation via external schedulers. Orchestrate complex, end‑to‑end imaging workflows with minimal user intervention for reliable, high‑throughput microscopy that runs continuously and scales with your lab.

NIS.API is intended for research purposes only, and is not designed for medical use.

Explore the API

NIS.API Documentation (445KB)

NIS.API Client Demo App (28 MB)

NIS.API connects your lab equipment, scheduling software, and microscope hardware through a single REST interface. No custom drivers, no manual steps.

Key Features

End-to-End Workflow Automation

Give external automation systems complete programmatic control for starting and stopping processes, managing hardware configurations and submitting imaging jobs for integrated acquisition and analysis. All from a single REST interface.

  • Start and stop NIS-Elements sessions from any HTTP client
  • Choose the correct NIS-Elements hardware configuration for the specific experiment being performed.
  • Submit imaging jobs with custom plate barcodes and output paths
  • Control stage positioning for loading and acquisition

Real-Time Status Monitoring

Stay fully informed at every stage with NIS.API. It offers real-time visibility by integrating system and device data directly into your scheduling workflows. Your automation logic always operates with an accurate, up-to-date view of system status.

  • Hardware configuration and connectivity status
  • Live JOB run status and progress reporting
  • Detect sample presence on the microscope stage automatically
  • Pending operator message handling for fully unattended runs

Integrated Post-Acquisition Processing

Automation doesn't stop at image capture. NIS.API exposes dedicated processing endpoints that let external systems trigger data management and other required pipelines immediately after acquisition. Keep data moving through your workflow without delays.

  • Generate time-course datasets from multiple runs of the same well plate.
  • Track task completion
  • Query results programmatically

Easy Integration

Easy, Standards-Based Integration

Connect in minutes using a fully open, REST-based interface with no proprietary SDKs or custom drivers required. NIS.API fits seamlessly into your existing automation infrastructure.

REST + HTTP Architecture

Integrate with any platform capable of making HTTP requests.

JSON Interface

Use clean, structured JSON for all requests and responses with comprehensive error codes and descriptive messages. 

Works Across Platforms

Compatible with Python, .NET, robotics platforms, LIMS, and more.

Local Network Deployment

NIS.API runs as a local service within your LAN, keeping imaging data and control signals securely within your facility network.

Open API Documentation

Explore endpoints and test workflows with interactive API docs before writing a single line of code.

Applications

Powering High-Throughput Science

Run hundreds of imaging jobs unattended across drug discovery, cell biology, and phenotyping without writing a single custom driver.

Drug Discovery & Pharma Sevices

Run high-content screening pipelines and meet demanding CRO throughput and reproducibility requirements, enabling unattended operation across hundreds of compounds with GxP-ready data integrity.

Cell Biology & Neuroscience

Capture long-term time-lapse data and scale phenotypic screening studies with automated incubators, liquid handlers, and programmatic consistency across every acquisition run.

Core Facility Management

Enable multi-user, multi-project facilities to queue, prioritize, and run jobs continuously across shared instruments without scheduling conflicts or instrument downtime.

Custom Lab Automation

Build bespoke pipelines using any HTTP-capable platform. NIS.API's open architecture integrates with existing LIMS, robotics middleware, and custom scheduling tools with no proprietary SDK required.

Requirements

What You Need to Get Started

  • Software Version

    NIS-Elements version 7.01 build 2222 or later

  • License Requirements
    • NIS.API module
    • AR+6D+JOBS  |  C+JOBS  |  HC
  • Network

    Local Area Network (LAN)

  • Protocol

    HTTP REST API using JSON over standard HTTPS methods (GET, POST, PATCH, DELETE)