Skip to content

docs: tutorials: update api workshop page #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NicolasCARPi merged 2 commits into from
May 6, 2026
Merged

docs: tutorials: update api workshop page #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72e00b2
docs: tutorials: update api workshop page
MoustaphaCamara May 5, 2026
a5d74a7
replace <br> to closing tag <br /> for markdown compatibility
MoustaphaCamara May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions docs/tutorials/api-workshop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,25 @@ title: API Workshop

# API Workshop

We created a workshop to get started with the HTTP REST API provided by eLabFTW.
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 recording of this workshop, suitable to beginners, is available in this 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.

<iframe width="560" height="315" src="https://www.youtube.com/embed/8Ag-saY47VE?si=XIRdtSBb00dXcRAo" title="eLabFTW API Workshop Video" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

## Links

- [Repository link](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop)
- [Endpoints documentation](https://doc.elabftw.net/api/v2/)
- [Python library repository](https://github.com/elabftw/elabapi-python)
- [HTML documentation](https://doc.elabftw.net/api/elabapi-html/)

- [API Workshop repository](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop) <br />➡️ Contains the Jupyter notebooks used in this workshop, along with setup instructions to run them locally or in Google Colab.
- [API endpoints documentation](https://doc.elabftw.net/api/v2/) <br />➡️ Reference documentation listing all available API endpoints, parameters, and expected responses.
- [Python library (elabapi-python)](https://github.com/elabftw/elabapi-python) <br />➡️ Official Python client to interact with the eLabFTW API without writing raw HTTP requests.
- [Python library HTML documentation](https://doc.elabftw.net/api/elabapi-html/) <br />➡️ Detailed documentation of the Python library, including available methods and usage examples.