Benchling

Benchling Procedure Step Execution Instance API

An execution instance of a procedure step within a `ProcedureMethodExecutionInstance`. Created when a procedure run is started, representing a step where scientists can document their work. The `document` field links to a `Document` (entry) where scientists write notes, observations, and results during execution. References both `planStepVersion` (from the run plan flowchart) and `templateStepVersion` (from the original procedure template) to track provenance—these are null for ad-hoc steps added during execution or auto-generated confirmation steps. The `stepTask` provides workflow orchestration via `WorkflowTask`. Can be archived along with its parent method execution instance through the `ArchivableWithLineage` lineage. Also known as a "step entry" or "execution step" in the Benchling UI.

Documentation GitHub OpenAPI

Operations 2

GET /procedure-step-execution-instance/items List ProcedureStepExecutionInstance items #

GET /procedure-step-execution-instance/{procedure_step_execution_instance_id} Get ProcedureStepExecutionInstance by ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/benchling-procedurestepexecutioninstance-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling Procedure Step Execution Instance API
  version: 2.0.0
  description: 'An execution instance of a procedure step within a `ProcedureMethodExecutionInstance`. Created

    when a procedure run is started, representing a step where scientists can document their work.

    The `document` field links to a `Document` (entry) where scientists write notes, observations,

    and results during execution. References both `planStepVersion` (from the run plan flowchart)

    and `templateStepVersion` (from the original procedure template) to track provenance—these are

    null for ad-hoc steps added during execution or auto-generated confirmation steps. The

    `stepTask` provides workflow orchestration via `WorkflowTask`. Can be archived along with its

    parent method execution instance through the `ArchivableWithLineage` lineage. Also known as a

    "step entry" or "execution step" in the Benchling UI.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'An execution instance of a procedure step within a `ProcedureMethodExecutionInstance`. Created

    when a procedure run is started, representing a step where scientists can document their work.

    The `document` field links to a `Document` (entry) where scientists write notes, observations,

    and results during execution. References both `planStepVersion` (from the run plan flowchart)

    and `templateStepVersion` (from the original procedure template) to track provenance—these are

    null for ad-hoc steps added during execution or auto-generated confirmation steps. The

    `stepTask` provides workflow orchestration via `WorkflowTask`. Can be archived along with its

    parent method execution instance through the `ArchivableWithLineage` lineage. Also known as a

    "step entry" or "execution step" in the Benchling UI.'
  name: ProcedureStepExecutionInstance
  x-bnch-organization: Benchling
paths:
  /procedure-step-execution-instance/items:
    get:
      description: List ProcedureStepExecutionInstance items.
      operationId: ProcedureStepExecutionInstance.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/createdAt.gt'
      - $ref: '#/components/parameters/createdAt.gte'
      - $ref: '#/components/parameters/createdAt.lt'
      - $ref: '#/components/parameters/createdAt.lte'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/methodExecutionInstance.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.'
        in: query
        name: sort
        schema:
          default: modifiedAt:desc
          enum:
          - createdAt:asc
          - createdAt:desc
          - modifiedAt:asc
          - modifiedAt:desc
          type: string
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureStepExecutionInstancePaginatedList'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List ProcedureStepExecutionInstance items
      tags:
      - ProcedureStepExecutionInstance
      x-bnch-rate-limit-tier: 4
  /procedure-step-execution-instance/{procedure_step_execution_instance_id}:
    get:
      description: Get a single ProcedureStepExecutionInstance by ID.
      operationId: ProcedureStepExecutionInstance.Get
      parameters:
      - description: ID of the ProcedureStepExecutionInstance.
        in: path
        name: procedure_step_execution_instance_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureStepExecutionInstance'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get ProcedureStepExecutionInstance by ID
      tags:
      - ProcedureStepExecutionInstance
      x-bnch-rate-limit-tier: 5
components:
  parameters:
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    createdAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: createdAt.gte
      schema:
        format: datetime
        type: string
    modifiedAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.
      in: query
      name: modifiedAt.gt
      schema:
        format: datetime
        type: string
    modifiedAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: modifiedAt.lte
      schema:
        format: datetime
        type: string
    id.anyOf:
      description: Restricts results to those matching any of the specified IDs. Comma-separated list.
      explode: false
      in: query
      name: id.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    omit:
      description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
      explode: false
      in: query
      name: omit
      schema:
        items:
          type: string
        type: array
    modifiedAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.
      in: query
      name: modifiedAt.lt
      schema:
        format: datetime
        type: string
    createdAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.
      in: query
      name: createdAt.gt
      schema:
        format: datetime
        type: string
    methodExecutionInstance.anyOf:
      description: Restricts results to only those that are part of procedure method execution instances matching any of the specified procedure method execution instance IDs. Comma-separated list.
      explode: false
      in: query
      name: methodExecutionInstance.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    createdAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.
      in: query
      name: createdAt.lt
      schema:
        format: datetime
        type: string
    archiveReason.anyOf:
      description: Restricts items to those with any of the specified archive reasons. Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived. Comma-separated list.
      explode: false
      in: query
      name: archiveReason.anyOf
      schema:
        items:
          type: string
        maxItems: 10
        type: array
    returning:
      description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
      explode: false
      in: query
      name: returning
      schema:
        items:
          type: string
        type: array
    archived.anyOf:
      description: If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list.
      explode: false
      in: query
      name: archived.anyOf
      schema:
        items:
          type: boolean
        maxItems: 2
        type: array
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    modifiedAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: modifiedAt.gte
      schema:
        format: datetime
        type: string
    createdAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: createdAt.lte
      schema:
        format: datetime
        type: string
  responses:
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Too Many Requests
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  schemas:
    InternalServerError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        errorId:
          type: string
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    ProcedureMethodExecutionInstanceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureStepExecutionInstance:
      description: 'An execution instance of a procedure step within a `ProcedureMethodExecutionInstance`. Created

        when a procedure run is started, representing a step where scientists can document their work.

        The `document` field links to a `Document` (entry) where scientists write notes, observations,

        and results during execution. References both `planStepVersion` (from the run plan flowchart)

        and `templateStepVersion` (from the original procedure template) to track provenance—these are

        null for ad-hoc steps added during execution or auto-generated confirmation steps. The

        `stepTask` provides workflow orchestration via `WorkflowTask`. Can be archived along with its

        parent method execution instance through the `ArchivableWithLineage` lineage. Also known as a

        "step entry" or "execution step" in the Benchling UI.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        methodExecutionInstance:
          $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        templateStepVersion:
          oneOf:
          - $ref: '#/components/schemas/ProcedureStepDefinitionVersionRef'
          - type: 'null'
      type: object
    ProcedureStepDefinitionVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureStepExecutionInstancePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureStepExecutionInstance'
          type: array
        nextToken:
          type: string
      type: object
    GeneralError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
  securitySchemes:
    basicApiKeyAuth:
      description: Use issued API key for standard access to the API
      scheme: basic
      type: http
    basicClientIdSecretAuth:
      description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
      scheme: basic
      type: http
    oAuth:
      description: OAuth2 Client Credentials flow intended for service access
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth/token
      type: oauth2