API

Your Python package to simplify Computer Vision development

Test and train algorithms, and build reusable workflows with a few lines of code.

Say goodbye to installation bugs and dependencies issues for good

Use the same Python code patterns to run and train any algorithm regardless of its source.
Algorithms are downloaded automatically, and all you need to do is adjust parameters and iterate.

Algorithms from all frameworks become interoperable

Classical or deep learning, select and chain the best SOTA Computer Vision algorithms from your preferred frameworks (OpenCV, OpenMMlab, Detectron2, YOLO, HuggingFace, etc.).

Go to the HUB

Process all visual data

The Ikomia API processes the full range of visual data: images, videos, video streams, sequences of images.
Load custom data with the dataset loaders.

Don’t worry about inputs
and outputs

Inputs and outputs are chained, so that you can build your workflow seamlessly.

Modify or insert your code and control all parameters

Have full control of code and settings, everything is editable and there is no imposed automation.

Reuse JSON of the final output anywhere

Once your workflow is functional and tested, deploy it anywhere thanks to JSON format.

Test the API

Get started

Read the doc

Features

Easy algorithm selection

With auto-completion, select any of the 280 algorithms. They are ready-to-use and can be edited.

Multi framework

Classical or deep learning, choose from the best SOTA Computer Vision algorithms from your preferred frameworks such as OpenCV, OpenMMlab, Detectron2, YOLO, HuggingFace and more.

Automatic download and installation

Algorithms are plug-and-play: they download and install for immediate use.

Use any data format

Process the full range of visual data: images, videos, video streams, sequences of images.

Plug annotated data whatever the source

Load custom data thanks to the dataset loaders, whether you annotated with Roboflow, CVAT or another software.

One code pattern executes them all

Test multiple algorithms in minutes with the same Python code pattern.

Easily define algorithms settings

Control all settings with the auto-completion tool.

Watch the results with just one line of command

Inspect the effects of your image processing with smart functions.

Download and install training algorithms on a desktop or computing server.

Load custom data to train models on a desktop or another machine.

Control all algorithm and model parameters

All the parameters of each algorithm are exposed so that they can be modified.

Monitor experiments

MLflow and TensorBoard are integrated by default with Ikomia.

Chain algorithms from any framework with a unique workflow system

Algorithms are chained in a few lines of code. Inputs and outputs connect to build a workflow without a glitch.

Insert your own algorithms

Mix your algorithms with ones selected from the best frameworks in the same workflow.

Run your entire workflow with one line of code

On a single image, multiple images, or in a batch.

Export your workflow in JSON format

All elements are described in the JSON file: algorithms, parameters and connections.

Reuse the JSON output anywhere

Load and execute the JSON file of your workflow on all desktops and computing servers.

Coming soon : SCALE

Push and deploy your workflows on dedicated endpoints in a few clicks.

Whether more documentation or test-it-first, the following is the content to get started:

Start your project

Get started

Read the doc

FAQ

Don’t see your question? Email team@ikomia.ai.

What does it cost?

The Ikomia HUB, API, and STUDIO are open source and free, and will always be!

What are the prerequisites?

You will be comfortable using the API if you have a background in Python, OpenCV, deep learning, and image / video processing. You also need to be familiar with Python libraries.

Does it need to be installed?

Yes, just type pip install ikomia.

What’s the difference between STUDIO and API?

STUDIO offers the same features as the API but in a desktop application.

Is there documentation?

Sure, the full documentation is here: https://ikomia-dev.github.io/python-api-documentation/.

Do I need the HUB to use the API?

No login to the HUB or installation is necessary: the API downloads the customized algorithms from the HUB when you select them in the code. Visit the to read the full list of algorithms.

What is a workflow?

A workflow is a sequence of connected tasks (algorithms) that process input data and produce output results. It can create, customize, and run a series of algorithms in a specific order to achieve a desired outcome.

Can I do batch inference with the API?

Indeed. Run the algorithm on your folder and every image inside this folder will be processed.

If I train a model using Ikomia API, and develop a solution using the ikomia API, can I commercialize it?

Ikomia API is licensed under the Apache 2.0 License. Feel free to use it in a commercial app. Please note that each algorithm in Ikomia HUB has a license and some are less permissive.

How can I create my own algorithm?

We provide the necessary tool to easily create your own algorithm. You can find the “How to” in the documentation.