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

Opentrons Run Management API

Create and control protocol runs

Opentrons Run 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 Run Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

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

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

9 operations 5 paths 15 schemas 1 DELETE4 GET1 PATCH3 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
License
Resource Areas
1

Paths & Operations 9

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

Run Management 9

Create and control protocol runs

POST
/runs
Create a run
createRun 1 param body → 201
GET
/runs
Get all runs
getRuns 2 params → 200
GET
/runs/{runId}
Get a run
getRun 2 params → 200404
DELETE
/runs/{runId}
Delete a run
deleteRun 2 params → 200
PATCH
/runs/{runId}
Update a run
updateRun 2 params body → 200
POST
/runs/{runId}/actions
Issue a control action to the run
createRunAction 2 params body → 201
POST
/runs/{runId}/commands
Enqueue a command
createRunCommand 4 params body → 201
GET
/runs/{runId}/commands
Get a list of all protocol commands in the run
getRunCommands 4 params → 200
GET
/runs/{runId}/commands/{commandId}
Get full details about a specific command in the run
getRunCommand 3 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Command (11 properties), Run (11 properties), ErrorDetail (4 properties), CommandListResponse (3 properties). Each schema is shown below with its type and property counts.

UpdateRunRequest
object
1 property
CommandResponse
object
1 property
RunResponse
object
2 properties
ErrorDetail
object
4 properties
RunActionRequest
object
1 property 1 required
RunAction
object
3 properties
CreateRunRequest
object
1 property
Command
object
A command that was executed or is queued
11 properties
RunListResponse
object
3 properties
CommandRequest
object
A command to execute on the robot
1 property 1 required
Run
object
A protocol run on the robot
11 properties 9 required
ErrorResponse
object
Error response from the API
1 property
RunActionResponse
object
1 property
CommandListResponse
object
3 properties
MultiBodyMeta
object
Pagination metadata for multi-item responses
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Opentrons publishes across the network.

Opentrons Python Protocol API
Opentrons Attached Instruments API
Opentrons Attached Modules API
Opentrons Flex Deck Configuration API
Opentrons Health API
Opentrons Protocol Management API
Opentrons Robot API
Opentrons Simple Commands API
Opentrons System Control API
Where this information came from

This is an independent, third-party profile of Opentrons Run 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.