How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Opentrons

Opentrons Protocol Management API

Upload, manage, and analyze protocols

Documentation Provider Profile APIs.io OpenAPI GitHub

Opentrons Protocol Management API is one of 10 APIs that Opentrons publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Protocol Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 7 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 4.

Requests are made against a single base URL, http://{robotIP}:31950.

7 operations 4 paths 13 schemas 1 DELETE4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4
Base URL
http://{ROBOT_IP}:31950
Contact
Opentrons Support
License
Apache 2.0
Resource Areas
1

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Protocol Management 7

Upload, manage, and analyze protocols

POST
/protocols
Upload a protocol
uploadProtocol 1 param body → 201422
GET
/protocols
Get uploaded protocols
getProtocols 2 params → 200
GET
/protocols/{protocolId}
Get an uploaded protocol
getProtocol 2 params → 200404
DELETE
/protocols/{protocolId}
Delete an uploaded protocol
deleteProtocol 2 params → 200404409
POST
/protocols/{protocolId}/analyses
Analyze the protocol
analyzeProtocol 2 params body → 200
GET
/protocols/{protocolId}/analyses
Get a protocol's analyses
getProtocolAnalyses 2 params → 200
GET
/protocols/{protocolId}/analyses/{analysisId}
Get one of a protocol's analyses
getProtocolAnalysis 3 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ProtocolAnalysis (10 properties), ProtocolMetadata (8 properties), Protocol (8 properties), ErrorDetail (4 properties). Each schema is shown below with its type and property counts.

ProtocolFile
object
2 properties
Protocol
object
A protocol uploaded to the robot
8 properties 7 required
AnalysisRequest
object
3 properties
ProtocolResponse
object
2 properties
ErrorDetail
object
4 properties
AnalysisSummaryResponse
object
1 property
ProtocolAnalysis
object
The result of analyzing a protocol
10 properties
AnalysisListResponse
object
1 property
AnalysisSummary
object
2 properties
ProtocolMetadata
object
Metadata extracted from the protocol
8 properties
ProtocolListResponse
object
2 properties
ErrorResponse
object
Error response from the API
1 property
MultiBodyMeta
object
Pagination metadata for multi-item responses
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opentrons-protocol-management-api-openapi.yml Raw ↑

Other APIs Opentrons publishes across the network.

Opentrons Python Protocol API
AE Profile APIs.io
Opentrons Attached Instruments API
AE Profile APIs.io
Opentrons Attached Modules API
AE Profile APIs.io
Opentrons Flex Deck Configuration API
AE Profile APIs.io
Opentrons Health API
AE Profile APIs.io
Opentrons Robot API
AE Profile APIs.io
Opentrons Run Management API
AE Profile APIs.io
Opentrons Simple Commands API
AE Profile APIs.io
Opentrons System Control API
AE Profile APIs.io
#Protocol Management
← Back to O APIs
API Details
ID
opentrons:opentrons-protocol-management-api
Base URL
http://{ROBOT_IP}:31950
Docs
https://github.com/Opentrons/opentrons-integration-tools/tree/main/http-api
Provider
Opentrons
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=opentrons-protocol-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/opentrons-protocol-management-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Opentrons Protocol Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.