API Workshop

This workshop introduces how to interact with the eLabFTW REST API using Jupyter notebooks. It provides a hands-on, step-by-step learning experience where you can execute requests, explore responses, and automate workflows directly from your browser or local environment.

The workshop is organized into multiple notebooks, guiding you from basic API concepts to practical usage with tools like curl and Python. It is designed for beginners as well as intermediate users who want to better understand and use the API in real scenarios.

You can run the notebooks:

• Locally with JupyterLab (recommended for full control)
• Online using Google Colab (no installation required)

Detailed setup instructions are available in the repository.

Video

A full walkthrough of the workshop is available in the video below. It follows the same structure as the notebooks and demonstrates how to interact with the API step by step using Jupyter.

Links

• API Workshop repository
  ➡️ Contains the Jupyter notebooks used in this workshop, along with setup instructions to run them locally or in Google Colab.
• API endpoints documentation
  ➡️ Reference documentation listing all available API endpoints, parameters, and expected responses.
• Python library (elabapi-python)
  ➡️ Official Python client to interact with the eLabFTW API without writing raw HTTP requests.
• Python library HTML documentation
  ➡️ Detailed documentation of the Python library, including available methods and usage examples.