Labstep

Labstep API

The Labstep REST API exposes the same generic entity surface the Labstep application uses — experiments, protocols, resources, resource items, locations, devices, device data, orders, metadata, files, tags, collections, workspaces and users. Requests are authenticated with a per-user API key sent in an `apikey` header (an Authorization Bearer token form is also supported), and entities are read, filtered, created, edited and deleted under `/api/generic/` with a POST `/filter` endpoint for structured predicate queries.

GitHub

Documentation

📖
Documentation
https://help.labstep.com/en/collections/1913112-labstep-api
📖
GettingStarted
https://help.labstep.com/en/articles/1786226-getting-started-with-the-labstep-api
📖
APIReference
https://labsteppy.readthedocs.io/en/latest/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/labstep/refs/heads/main/authentication/labstep-authentication.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/labstep/refs/heads/main/conventions/labstep-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/labstep/refs/heads/main/errors/labstep-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/labstep/refs/heads/main/data-model/labstep-data-model.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/labstep/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
aid: labstep:labstep-api
name: Labstep API
description: The Labstep REST API exposes the same generic entity surface the Labstep application uses
  — experiments, protocols, resources, resource items, locations, devices, device data, orders, metadata,
  files, tags, collections, workspaces and users. Requests are authenticated with a per-user API key sent
  in an `apikey` header (an Authorization Bearer token form is also supported), and entities are read,
  filtered, created, edited and deleted under `/api/generic/<entity>` with a POST `/filter` endpoint for
  structured predicate queries.
humanURL: https://help.labstep.com/en/collections/1913112-labstep-api
baseURL: https://api.labstep.com
tags:
- Electronic Lab Notebook
- Research Data
- Laboratory
properties:
- type: Documentation
  url: https://help.labstep.com/en/collections/1913112-labstep-api
- type: GettingStarted
  url: https://help.labstep.com/en/articles/1786226-getting-started-with-the-labstep-api
- type: APIReference
  url: https://labsteppy.readthedocs.io/en/latest/
- type: Authentication
  url: authentication/labstep-authentication.yml
- type: Conventions
  url: conventions/labstep-conventions.yml
- type: ErrorCatalog
  url: errors/labstep-error-codes.yml
- type: DataModel
  url: data-model/labstep-data-model.yml