protocolsio-integration

Protocols.io Integration - Scientific Protocol Management API Integration

Skill Overview

A complete protocols.io API v3 integration tool that helps researchers programmatically manage scientific experimental protocols, workspaces, and collaboration workflows.

Use Cases

1. Digital Management of Laboratory Protocols

Unify and digitize laboratory experimental plans, operating procedures, reagents, and materials. Supports creating structured protocol documents, adding detailed step descriptions, associating material lists, and generating citable DOIs. Suitable for research teams that need to standardize experimental procedures and improve reproducibility.

2. Team Scientific Collaboration and Sharing

Collaboratively develop and manage protocols in multi-member workspaces. Team members can comment on and discuss protocol content, share experimental data files, and track their individual experiment records. Especially suitable for large research projects spanning labs or institutions.

3. Protocol Discovery and Integration

Search the public protocol repository on the protocols.io platform to find mature solutions in relevant fields and integrate them into your workflow. Supports filtering by keywords, DOI, or category, viewing community comments and feedback, and generating PDFs for offline reference.

Core Features

1. Full Protocol Lifecycle Management

Support for the full process of creating, editing, and publishing scientific protocols. Manage protocol metadata and tags, add and arrange steps, record reagents and materials, apply for DOI publication, and manage protocol versions. Supports exporting content in JSON, HTML, and Markdown formats.

2. Workspaces and Permissioned Collaboration

Create team workspaces and manage member roles and access permissions. Organize protocol libraries within workspaces, share file resources, and conduct discussions and comments. Supports multi-user collaborative development and protocol review workflows.

3. File Management and Experiment Tracking

Upload and manage experiment-related files (data, images, documents), with support for folder organization. Create experiment execution records, link uploaded data files, and record modifications and optimizations made during protocol execution. Supports data backup and migration/export.

Frequently Asked Questions

How does the protocols.io API authenticate?

Uses Bearer Token authentication. Supports CLIENT_ACCESS_TOKEN (personal access) and OAUTH_ACCESS_TOKEN (multi-user applications). The OAuth flow requires generating an authorization link; after the user authorizes, the authorization code is exchanged for an access token, which can be refreshed after expiration. See references/authentication.md for details.

How do I create a new scientific protocol via the API?

Use the POST /protocols endpoint to create a protocol by submitting a title, description, and tags. After creation, use POST /protocols/{id}/steps to add steps and record reagents and materials within step components. Once content is complete, use POST /protocols/{id}/publish to apply for DOI publication. All requests must include Authorization: Bearer YOUR_TOKEN in the header.

What are the rate limits for the protocols.io API?

Standard endpoints are limited to 100 requests per user per minute. The PDF generation endpoint is limited to 5 requests per minute for logged-in users or 3 requests per minute for anonymous users. When encountering HTTP 429 errors, implement exponential backoff and retry, waiting according to the Retry-After header before retrying.