Benchling API v3
Benchling's unified v3 REST API — a single contract of 805 paths and 874 operations spanning the electronic lab notebook, entity registry, inventory, assay results and runs, and workflow and procedure execution. Released as the successor to the v2 surface, it returns RFC 9457 problem details (application/problem+json), tags every operation with a rate-limit tier (x-bnch-rate-limit-tier 1-5), adds `returning`/`omit` field selection and batch write endpoints, and folds the former v3-alpha and v3-beta routes into one base path gated by an EARLY-ACCESS request header. The spec also declares 14 outbound webhooks. Published unauthenticated by Benchling at https://benchling.com/api/v3/openapi.yaml.
Benchling API v3 is one of 58 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include REST, Unified-API, Electronic Lab Notebook, Registry, and Inventory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.
This API exposes 874 operations across 805 paths, organized into 149 resource areas, and defines 1167 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, /api/v3.
874 operations
805 paths
1167 schemas
6 DELETE440 GET189 PATCH239 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Benchling API v3 declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicApiKeyAuth).
It accepts HTTP basic authentication (basicClientIdSecretAuth).
It supports OAuth 2.0 (oAuth) using the clientCredentials flow.
By default, every request must be authenticated.
basicApiKeyAuth— Use issued API key for standard access to the APIbasicClientIdSecretAuth— Auth used as part of client credentials OAuth flow prior to receiving a bearer token.oAuth— OAuth2 Client Credentials flow intended for service access
Paths & Operations 874
Across 805 paths, the API surfaces 874 operations — 6 DELETE, 440 GET, 189 PATCH, 239 POST. They span 149 resource areas, including AaSequence, AaSequenceSchema, Agent, AnalysisTemplateDataFrameVariable, AnalysisTemplateVariable, AnalysisTemplate, Analysis, AppCanvas, and 141 more. Each is listed below with its method, path, parameters, and response codes.
AaSequence 9
Represents an amino acid sequence in Benchling's molecular biology platform. An AaSequence stores the one-letter amino acid code string along with annotations marking functional r…
POST
/aa-sequence
Create AaSequence
GET
/aa-sequence/items
List AaSequence items
GET
/aa-sequence/{aa_sequence_id}
Get AaSequence by ID
PATCH
/aa-sequence/{aa_sequence_id}
Update AaSequence
GET
/aa-sequence/{aa_sequence_id}/authors/items
List Principal items
POST
/aa-sequence:batch-create
Batch create AaSequence
PATCH
/aa-sequence:batch-update
Batch update AaSequence
POST
/aa-sequence:bulk-create
Bulk create AaSequence
PATCH
/aa-sequence:bulk-update
Bulk update AaSequence
AaSequenceSchema 14
Defines the structure, field definitions, and configuration options for AA sequences.
POST
/aa-sequence-schema
Create AaSequenceSchema
GET
/aa-sequence-schema/items
List AaSequenceSchema items
GET
/aa-sequence-schema/{aa_sequence_schema_id}
Get AaSequenceSchema by ID
PATCH
/aa-sequence-schema/{aa_sequence_schema_id}
Update AaSequenceSchema
GET
/aa-sequence-schema/{aa_sequence_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/aa-sequence-schema/{aa_sequence_schema_id}/fieldsets/items
List Fieldset items
POST
/aa-sequence-schema/{aa_sequence_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/aa-sequence-schema/{aa_sequence_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/aa-sequence-schema:batch-create
Batch create AaSequenceSchema
PATCH
/aa-sequence-schema:batch-update
Batch update AaSequenceSchema
POST
/aa-sequence-schema:bulk-create
Bulk create AaSequenceSchema
PATCH
/aa-sequence-schema:bulk-update
Bulk update AaSequenceSchema
GET
/tasks/aa-sequence-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/aa-sequence-schema/set-field-definitions/{task_id}
Poll async task status
Agent 1
POST
/agents
Create or continue a chat with an agent
AnalysisTemplateDataFrameVariable 2
Defines a data frame placeholder within an AnalysisTemplate that users must provide when applying the template. Each variable specifies which PipelineStep input (replaceStep, repl…
GET
/analysis-template-data-frame-variable/items
List AnalysisTemplateDataFrameVariable items
GET
/analysis-template-data-frame-variable/{analysis_template_data_frame_variable_id}
Get AnalysisTemplateDataFrameVariable by ID
AnalysisTemplateVariable 2
Defines a configuration parameter within an AnalysisTemplate that users can customize when applying the template. Unlike AnalysisTemplateDataFrameVariable which handles data frame…
GET
/analysis-template-variable/items
List AnalysisTemplateVariable items
GET
/analysis-template-variable/{analysis_template_variable_id}
Get AnalysisTemplateVariable by ID
AnalysisTemplate 6
A reusable pipeline configuration that can be instantiated to create new Analysis objects. AnalysisTemplates define a complete data processing workflow with PipelineSteps (see ste…
GET
/analysis-template/items
List AnalysisTemplate items
GET
/analysis-template/{analysis_template_id}
Get AnalysisTemplate by ID
GET
/analysis-template/{analysis_template_id}/archivable-children/items
List AnalysisTemplateDataFrameVariable items
GET
/analysis-template/{analysis_template_id}/config-variables/items
List AnalysisTemplateVariable items
GET
/analysis-template/{analysis_template_id}/data-frame-variables/items
List AnalysisTemplateDataFrameVariable items
GET
/analysis-template/{analysis_template_id}/steps/items
List PipelineStep items
Analysis 3
Operations for Analysis
GET
/analysis/items
List Analysis items
GET
/analysis/{analysis_id}
Get Analysis by ID
GET
/analysis/{analysis_id}/steps/items
List PipelineStep items
AppCanvas 7
Represents a Benchling App canvas, an embedded UI surface that apps use to render custom interactive content within notebook entries, entry templates, assay runs, or app homepages…
POST
/app-canvas
Create AppCanvas
GET
/app-canvas/{app_canvas_id}
Get AppCanvas by ID
PATCH
/app-canvas/{app_canvas_id}
Update AppCanvas
POST
/app-canvas:batch-create
Batch create AppCanvas
PATCH
/app-canvas:batch-update
Batch update AppCanvas
POST
/app-canvas:bulk-create
Bulk create AppCanvas
PATCH
/app-canvas:bulk-update
Bulk update AppCanvas
AppConfigValue 2
Represents a configured value for a Benchling App on a specific tenant. Each config value has a path identifying its location in the configuration hierarchy and valueData containi…
GET
/app-config-value/items
List AppConfigValue items
GET
/app-config-value/{app_config_value_id}
Get AppConfigValue by ID
AppInstallation 3
Represents an installed Benchling App on a tenant, created from an AppDefinitionVersion. App installations store tenant-specific configuration values and feature bindings. As a Pr…
GET
/app-installation/items
List AppInstallation items
GET
/app-installation/{app_installation_id}
Get AppInstallation by ID
GET
/app-installation/{app_installation_id}/configuration-values/items
List AppConfigValue items
AppSession 8
Represents a running or completed session for a Benchling App. App sessions track long-running app operations, providing status updates and user-facing messages. Each session belo…
POST
/app-session
Create AppSession
GET
/app-session/items
List AppSession items
GET
/app-session/{app_session_id}
Get AppSession by ID
PATCH
/app-session/{app_session_id}
Update AppSession
POST
/app-session:batch-create
Batch create AppSession
PATCH
/app-session:batch-update
Batch update AppSession
POST
/app-session:bulk-create
Bulk create AppSession
PATCH
/app-session:bulk-update
Bulk update AppSession
Assembly 2
Represents a molecular cloning assembly that combines multiple DNA fragments into complete constructs. Assemblies model the process of joining fragment sequences (such as genes, p…
GET
/assembly/items
List Assembly items
GET
/assembly/{assembly_id}
Get Assembly by ID
AuditLog 4
Represents a single entry in an object's audit log. Each entry captures what changed, who made the change, and contextual information about the affected object hierarchy.
GET
/audit-log/items
List AuditLog items
GET
/audit-log/{audit_log_id}
Get AuditLog by ID
POST
/audit-log:export
Export the full audit log for an object as a CSV or PDF file
GET
/tasks/audit-log/export/{task_id}
Poll async task status
Box 8
A Box is a grid-based storage container in Benchling's inventory system, designed to hold multiple sample containers (tubes, vials, etc.) in an organized layout. Boxes have a defi…
POST
/box
Create Box
GET
/box/items
List Box items
GET
/box/{box_id}
Get Box by ID
PATCH
/box/{box_id}
Update Box
POST
/box:batch-create
Batch create Box
PATCH
/box:batch-update
Batch update Box
POST
/box:bulk-create
Bulk create Box
PATCH
/box:bulk-update
Bulk update Box
BoxSchema 9
Defines the structure and constraints for a category of Boxes in Benchling's inventory system. A BoxSchema specifies the grid dimensions (height and width) determining how many co…
POST
/box-schema
Create BoxSchema
GET
/box-schema/items
List BoxSchema items
GET
/box-schema/{box_schema_id}
Get BoxSchema by ID
PATCH
/box-schema/{box_schema_id}
Update BoxSchema
GET
/box-schema/{box_schema_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/box-schema:batch-create
Batch create BoxSchema
PATCH
/box-schema:batch-update
Batch update BoxSchema
POST
/box-schema:bulk-create
Bulk create BoxSchema
PATCH
/box-schema:bulk-update
Bulk update BoxSchema
BulkExport 1
POST
/bulk-export
Create a bulk export task
Chart 8
A Chart is a data visualization within Benchling. Charts can be created directly (for example, via APIs or the UI) or generated from other workflows. Charts store their configurat…
POST
/chart
Create Chart
GET
/chart/items
List Chart items
GET
/chart/{chart_id}
Get Chart by ID
PATCH
/chart/{chart_id}
Update Chart
POST
/chart:batch-create
Batch create Chart
PATCH
/chart:batch-update
Batch update Chart
POST
/chart:bulk-create
Bulk create Chart
PATCH
/chart:bulk-update
Bulk update Chart
Collaboration 10
A Collaboration indicates that a Principal or Group is granted a Policy on a Resource. Some Collaborations represent Ownership, while others indicate that a Resource was shared wi…
POST
/collaboration
Create Collaboration
GET
/collaboration/items
List Collaboration items
DELETE
/collaboration/{collaboration_id}
Delete Collaboration
GET
/collaboration/{collaboration_id}
Get Collaboration by ID
PATCH
/collaboration/{collaboration_id}
Update Collaboration
POST
/collaboration:batch-create
Batch create Collaboration
POST
/collaboration:batch-delete
Batch delete Collaboration
PATCH
/collaboration:batch-update
Batch update Collaboration
POST
/collaboration:bulk-create
Bulk create Collaboration
PATCH
/collaboration:bulk-update
Bulk update Collaboration
ConfigImportHistoryEntry 2
Records a configuration import operation from one Benchling tenant to another. Each entry captures the source tenant, target organization, who performed the import, and an optiona…
GET
/config-import-history-entry/items
List ConfigImportHistoryEntry items
GET
/config-import-history-entry/{config_import_history_entry_id}
Get ConfigImportHistoryEntry by ID
Container 12
A Container is a physical vessel (such as a tube, vial, or cryotube) that holds biological or chemical samples in Benchling's inventory system. Containers track their contents (se…
POST
/container
Create Container
GET
/container/items
List Container items
GET
/container/{container_id}
Get Container by ID
PATCH
/container/{container_id}
Update Container
POST
/container/{container_id}:remove-content
Remove content from a container.
POST
/container/{container_id}:update-content-concentration
Update the concentration of content in a container.
POST
/container:batch-create
Batch create Container
PATCH
/container:batch-update
Batch update Container
POST
/container:bulk-create
Bulk create Container
PATCH
/container:bulk-update
Bulk update Container
POST
/container:transfer
Transfer contents from sources into destination containers. Each row specifies a destination container and exactly one source (container or entity), the quantity to transfer, an optional final quanti…
GET
/tasks/container/transfer/{task_id}
Poll async task status
ContainerSchema 9
Defines the structure and metadata for a category of Containers in Benchling's inventory system. A ContainerSchema specifies the container type (e.g., "1.5mL Microcentrifuge Tube"…
POST
/container-schema
Create ContainerSchema
GET
/container-schema/items
List ContainerSchema items
GET
/container-schema/{container_schema_id}
Get ContainerSchema by ID
PATCH
/container-schema/{container_schema_id}
Update ContainerSchema
GET
/container-schema/{container_schema_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/container-schema:batch-create
Batch create ContainerSchema
PATCH
/container-schema:batch-update
Batch update ContainerSchema
POST
/container-schema:bulk-create
Bulk create ContainerSchema
PATCH
/container-schema:bulk-update
Bulk update ContainerSchema
CustomEntity 9
A flexible, user-defined entity type in Benchling's Registry. Unlike specialized entity types such as DnaSequence or Molecule, CustomEntities allow organizations to model any kind…
POST
/custom-entity
Create CustomEntity
GET
/custom-entity/items
List CustomEntity items
GET
/custom-entity/{custom_entity_id}
Get CustomEntity by ID
PATCH
/custom-entity/{custom_entity_id}
Update CustomEntity
GET
/custom-entity/{custom_entity_id}/authors/items
List Principal items
POST
/custom-entity:batch-create
Batch create CustomEntity
PATCH
/custom-entity:batch-update
Batch update CustomEntity
POST
/custom-entity:bulk-create
Bulk create CustomEntity
PATCH
/custom-entity:bulk-update
Bulk update CustomEntity
CustomEntitySchema 14
Operations for CustomEntitySchema
POST
/custom-entity-schema
Create CustomEntitySchema
GET
/custom-entity-schema/items
List CustomEntitySchema items
GET
/custom-entity-schema/{custom_entity_schema_id}
Get CustomEntitySchema by ID
PATCH
/custom-entity-schema/{custom_entity_schema_id}
Update CustomEntitySchema
GET
/custom-entity-schema/{custom_entity_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/custom-entity-schema/{custom_entity_schema_id}/fieldsets/items
List Fieldset items
POST
/custom-entity-schema/{custom_entity_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/custom-entity-schema/{custom_entity_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/custom-entity-schema:batch-create
Batch create CustomEntitySchema
PATCH
/custom-entity-schema:batch-update
Batch update CustomEntitySchema
POST
/custom-entity-schema:bulk-create
Bulk create CustomEntitySchema
PATCH
/custom-entity-schema:bulk-update
Bulk update CustomEntitySchema
GET
/tasks/custom-entity-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/custom-entity-schema/set-field-definitions/{task_id}
Poll async task status
DataFrame 2
DataFrame stores non-schematized tabular data, with Benchling-aware column types (see DataFrameColumn). Data frames are not searchable and lack their own permissions; rather, they…
GET
/data-frame/items
List DataFrame items
GET
/data-frame/{data_frame_id}
Get DataFrame by ID
Dataset 2
Dataset stores non-schematized tabular data, with Benchling-aware column types. Datasets are first-class, searchable, archivable folder items. A Dataset's actual data is stored in…
GET
/dataset/items
List Dataset items
GET
/dataset/{dataset_id}
Get Dataset by ID
DnaOligo 10
Represents a short single-stranded DNA oligonucleotide in Benchling's molecular biology platform. DNA oligos are typically synthetic sequences used as primers for PCR, probes for…
POST
/dna-oligo
Create DnaOligo
GET
/dna-oligo/items
List DnaOligo items
GET
/dna-oligo/{dna_oligo_id}
Get DnaOligo by ID
PATCH
/dna-oligo/{dna_oligo_id}
Update DnaOligo
GET
/dna-oligo/{dna_oligo_id}/authors/items
List Principal items
GET
/dna-oligo/{dna_oligo_id}/modified-nucleotides/items
List ModifiedNucleotide items
POST
/dna-oligo:batch-create
Batch create DnaOligo
PATCH
/dna-oligo:batch-update
Batch update DnaOligo
POST
/dna-oligo:bulk-create
Bulk create DnaOligo
PATCH
/dna-oligo:bulk-update
Bulk update DnaOligo
DnaOligoSchema 14
Defines the structure, field definitions, and configuration options for DNA oligos.
POST
/dna-oligo-schema
Create DnaOligoSchema
GET
/dna-oligo-schema/items
List DnaOligoSchema items
GET
/dna-oligo-schema/{dna_oligo_schema_id}
Get DnaOligoSchema by ID
PATCH
/dna-oligo-schema/{dna_oligo_schema_id}
Update DnaOligoSchema
GET
/dna-oligo-schema/{dna_oligo_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/dna-oligo-schema/{dna_oligo_schema_id}/fieldsets/items
List Fieldset items
POST
/dna-oligo-schema/{dna_oligo_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/dna-oligo-schema/{dna_oligo_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/dna-oligo-schema:batch-create
Batch create DnaOligoSchema
PATCH
/dna-oligo-schema:batch-update
Batch update DnaOligoSchema
POST
/dna-oligo-schema:bulk-create
Bulk create DnaOligoSchema
PATCH
/dna-oligo-schema:bulk-update
Bulk update DnaOligoSchema
GET
/tasks/dna-oligo-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/dna-oligo-schema/set-field-definitions/{task_id}
Poll async task status
DnaSequence 10
Represents a DNA sequence in Benchling's molecular biology platform. A DnaSequence stores the nucleotide bases of the forward strand along with rich annotations for biological fea…
POST
/dna-sequence
Create DnaSequence
GET
/dna-sequence/items
List DnaSequence items
GET
/dna-sequence/{dna_sequence_id}
Get DnaSequence by ID
PATCH
/dna-sequence/{dna_sequence_id}
Update DnaSequence
GET
/dna-sequence/{dna_sequence_id}/authors/items
List Principal items
GET
/dna-sequence/{dna_sequence_id}/parts/items
List DnaPart items
POST
/dna-sequence:batch-create
Batch create DnaSequence
PATCH
/dna-sequence:batch-update
Batch update DnaSequence
POST
/dna-sequence:bulk-create
Bulk create DnaSequence
PATCH
/dna-sequence:bulk-update
Bulk update DnaSequence
DnaSequenceSchema 14
Defines the structure, field definitions, and configuration options for DNA sequences.
POST
/dna-sequence-schema
Create DnaSequenceSchema
GET
/dna-sequence-schema/items
List DnaSequenceSchema items
GET
/dna-sequence-schema/{dna_sequence_schema_id}
Get DnaSequenceSchema by ID
PATCH
/dna-sequence-schema/{dna_sequence_schema_id}
Update DnaSequenceSchema
GET
/dna-sequence-schema/{dna_sequence_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/dna-sequence-schema/{dna_sequence_schema_id}/fieldsets/items
List Fieldset items
POST
/dna-sequence-schema/{dna_sequence_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/dna-sequence-schema/{dna_sequence_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/dna-sequence-schema:batch-create
Batch create DnaSequenceSchema
PATCH
/dna-sequence-schema:batch-update
Batch update DnaSequenceSchema
POST
/dna-sequence-schema:bulk-create
Bulk create DnaSequenceSchema
PATCH
/dna-sequence-schema:bulk-update
Bulk update DnaSequenceSchema
GET
/tasks/dna-sequence-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/dna-sequence-schema/set-field-definitions/{task_id}
Poll async task status
DocumentExport 3
POST
/document-export
Export a single item to a downloadable file
GET
/tasks/document-export/{task_id}
Get document export task status
GET
/tasks/document-export/{task_id}/download
Download a completed document export
DocumentPart 2
Represents an ordered piece of content within an entry, template, subtemplate, or document. Each document part wraps one content block and records its container, version, and audi…
GET
/document-part/items
List DocumentPart items
GET
/document-part/{document_part_id}
Get DocumentPart by ID
Dropdown 9
A configurable list of predefined values used for standardizing data entry in schema fields. Dropdowns provide controlled vocabulary choices that ensure consistency when users fil…
POST
/dropdown
Create Dropdown
GET
/dropdown/items
List Dropdown items
GET
/dropdown/{dropdown_id}
Get Dropdown by ID
PATCH
/dropdown/{dropdown_id}
Update Dropdown
GET
/dropdown/{dropdown_id}/options/items
List DropdownOption items
POST
/dropdown:batch-create
Batch create Dropdown
PATCH
/dropdown:batch-update
Batch update Dropdown
POST
/dropdown:bulk-create
Bulk create Dropdown
PATCH
/dropdown:bulk-update
Bulk update Dropdown
DropdownLinkFieldDefinition 2
A schema field definition that links to a dropdown for value selection. The linkDefinition field references the Dropdown configuration that defines the available options. When isM…
GET
/dropdown-link-field-definition/items
List DropdownLinkFieldDefinition items
GET
/dropdown-link-field-definition/{dropdown_link_field_definition_id}
Get DropdownLinkFieldDefinition by ID
DropdownOption 2
An individual selectable value within a Dropdown. Each DropdownOption represents one valid choice that users can select when populating a schema field configured with the parent D…
GET
/dropdown-option/items
List DropdownOption items
GET
/dropdown-option/{dropdown_option_id}
Get DropdownOption by ID
EntitySchema 3
Defines the structure and behavior for a category of registered entities in Benchling. EntitySchemas specify the field definitions (see fieldDefinitions and SchemaFieldDefinition)…
GET
/entity-schema/items
List EntitySchema items
GET
/entity-schema/{entity_schema_id}
Get EntitySchema by ID
GET
/entity-schema/{entity_schema_id}/field-definitions/items
List SchemaFieldDefinition items
Entry 11
An Entry is the core document type in Benchling's Electronic Lab Notebook (ELN), used by scientists to record experimental work and observations. Entries are organized into sectio…
POST
/entry
Create Entry
GET
/entry/items
List Entry items
GET
/entry/{entry_id}
Get Entry by ID
PATCH
/entry/{entry_id}
Update Entry
GET
/entry/{entry_id}/applicable-review-processes/items
List ReviewProcess items
GET
/entry/{entry_id}/authors/items
List Principal items
GET
/entry/{entry_id}/parts/items
List DocumentPart items
POST
/entry:batch-create
Batch create Entry
PATCH
/entry:batch-update
Batch update Entry
POST
/entry:bulk-create
Bulk create Entry
PATCH
/entry:bulk-update
Bulk update Entry
EntrySchema 3
Defines a schema that can be applied to Entries to add structured metadata through custom fields. Entry schemas allow organizations to standardize the information captured in note…
GET
/entry-schema/items
List EntrySchema items
GET
/entry-schema/{entry_schema_id}
Get EntrySchema by ID
GET
/entry-schema/{entry_schema_id}/field-definitions/items
List SchemaFieldDefinition items
EntrySubtemplate 2
A reusable content block that can be inserted into DocumentLike objects. Subtemplates contain pre-defined note content (text, tables, etc.) that scientists commonly need to repeat…
GET
/entry-subtemplate/items
List EntrySubtemplate items
GET
/entry-subtemplate/{entry_subtemplate_id}
Get EntrySubtemplate by ID
EntryTemplate 2
A template used to create new DocumentLike objects with pre-populated content and structure. EntryTemplates contain boilerplate text, tables, placeholders, and other note content…
GET
/entry-template/items
List EntryTemplate items
GET
/entry-template/{entry_template_id}
Get EntryTemplate by ID
EnzymeList 3
Represents a user-curated collection of restriction enzymes for molecular cloning workflows. EnzymeLists allow users and organizations to organize commonly used enzymes into named…
GET
/enzyme-list/items
List EnzymeList items
GET
/enzyme-list/{enzyme_list_id}
Get EnzymeList by ID
GET
/enzyme-list/{enzyme_list_id}/enzymes/items
List Enzyme items
Enzyme 3
Represents a restriction enzyme from Benchling's global catalog of commercially available enzymes. Restriction enzymes (also known as restriction endonucleases) are molecular scis…
GET
/enzyme/items
List Enzyme items
GET
/enzyme/{enzyme_id}
Get Enzyme by ID
GET
/enzyme/{enzyme_id}/isoschizomers/items
List Enzyme items
EquipmentSchema 14
Defines the structure, field definitions, and configuration options for Equipments.
POST
/equipment-schema
Create EquipmentSchema
GET
/equipment-schema/items
List EquipmentSchema items
GET
/equipment-schema/{equipment_schema_id}
Get EquipmentSchema by ID
PATCH
/equipment-schema/{equipment_schema_id}
Update EquipmentSchema
GET
/equipment-schema/{equipment_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/equipment-schema/{equipment_schema_id}/fieldsets/items
List Fieldset items
POST
/equipment-schema/{equipment_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/equipment-schema/{equipment_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/equipment-schema:batch-create
Batch create EquipmentSchema
PATCH
/equipment-schema:batch-update
Batch update EquipmentSchema
POST
/equipment-schema:bulk-create
Bulk create EquipmentSchema
PATCH
/equipment-schema:bulk-update
Bulk update EquipmentSchema
GET
/tasks/equipment-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/equipment-schema/set-field-definitions/{task_id}
Poll async task status
EventSubscription 2
Configures delivery of Benchling events to external systems via AWS EventBridge. Event subscriptions enable real-time integration by streaming events (such as entity creation, upd…
GET
/event-subscription/items
List EventSubscription items
GET
/event-subscription/{event_subscription_id}
Get EventSubscription by ID
FeatureLibraryItem 2
Represents a single feature definition within a FeatureLibrary used for auto-annotation. Each item defines a searchable pattern (nucleotide or amino acid sequence), a feature type…
GET
/feature-library-item/items
List FeatureLibraryItem items
GET
/feature-library-item/{feature_library_item_id}
Get FeatureLibraryItem by ID
FeatureLibrary 3
Represents a reusable collection of biological features for auto-annotating nucleotide and AA sequences. FeatureLibraries enable users to define common sequence motifs (such as ge…
GET
/feature-library/items
List FeatureLibrary items
GET
/feature-library/{feature_library_id}
Get FeatureLibrary by ID
GET
/feature-library/{feature_library_id}/features/items
List FeatureLibraryItem items
Fieldset 11
A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. Fieldsets are created and managed by tenant adminis…
POST
/fieldset
Create Fieldset
GET
/fieldset/items
List Fieldset items
GET
/fieldset/{fieldset_id}
Get Fieldset by ID
PATCH
/fieldset/{fieldset_id}
Update Fieldset
GET
/fieldset/{fieldset_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/fieldset/{fieldset_id}:set-field-definitions
Set field definitions on the fieldset
POST
/fieldset:batch-create
Batch create Fieldset
PATCH
/fieldset:batch-update
Batch update Fieldset
POST
/fieldset:bulk-create
Bulk create Fieldset
PATCH
/fieldset:bulk-update
Bulk update Fieldset
GET
/tasks/fieldset/set-field-definitions/{task_id}
Poll async task status
File 8
A File represents an uploaded document or data file that is surfaced in Benchling's Data Catalog for discovery and organization. Files are primarily created through Benchling Conn…
POST
/file
Create File
GET
/file/items
List File items
GET
/file/{file_id}
Get File by ID
PATCH
/file/{file_id}
Update File
POST
/file:batch-create
Batch create File
PATCH
/file:batch-update
Batch update File
POST
/file:bulk-create
Bulk create File
PATCH
/file:bulk-update
Bulk update File
Folder 12
A hierarchical container for organizing entities, notebook entries, and other items within a Project. Folders support nested structures through parent-child relationships (see par…
POST
/folder
Create Folder
GET
/folder/items
List Folder items
DELETE
/folder/{folder_id}
Delete Folder
GET
/folder/{folder_id}
Get Folder by ID
PATCH
/folder/{folder_id}
Update Folder
GET
/folder/{folder_id}/children/items
List Folder items
POST
/folder/{folder_id}:move
Move a Folder into another Folder
POST
/folder:batch-create
Batch create Folder
POST
/folder:batch-delete
Batch delete Folder
PATCH
/folder:batch-update
Batch update Folder
POST
/folder:bulk-create
Bulk create Folder
PATCH
/folder:bulk-update
Bulk update Folder
Germline 2
A database of reference sequences used to characterize protein sequences via alignment.
GET
/germline/items
List Germline items
GET
/germline/{germline_id}
Get Germline by ID
GroupMembership 2
Indicates that a Principal is a member of Group. Role indicates that the Principal is a member of a subgroup, such as Admins of the Group. Teams are the canonical example of a Gro…
GET
/group-membership/items
List GroupMembership items
GET
/group-membership/{group_membership_id}
Get GroupMembership by ID
LabelTemplate 2
A LabelTemplate defines the format for printing physical labels for inventory items, such as containers, plates, and boxes. Each template contains a template string, zplTemplate,…
GET
/label-template/items
List LabelTemplate items
GET
/label-template/{label_template_id}
Get LabelTemplate by ID
LegacyAppInstallation 3
Represents a legacy (pre-App Store) Benchling App installation on a tenant. Legacy apps are configured directly with webhook URLs and configuration specs rather than through app d…
GET
/legacy-app-installation/items
List LegacyAppInstallation items
GET
/legacy-app-installation/{legacy_app_installation_id}
Get LegacyAppInstallation by ID
GET
/legacy-app-installation/{legacy_app_installation_id}/configuration-values/items
List AppConfigValue items
LibraryParameterDefinition 8
A reusable parameter definition stored in the Parameter Library. LibraryParameterDefinitions allow organizations to standardize parameters used across multiple procedures by defin…
POST
/library-parameter-definition
Create LibraryParameterDefinition
GET
/library-parameter-definition/items
List LibraryParameterDefinition items
GET
/library-parameter-definition/{library_parameter_definition_id}
Get LibraryParameterDefinition by ID
PATCH
/library-parameter-definition/{library_parameter_definition_id}
Update LibraryParameterDefinition
POST
/library-parameter-definition:batch-create
Batch create LibraryParameterDefinition
PATCH
/library-parameter-definition:batch-update
Batch update LibraryParameterDefinition
POST
/library-parameter-definition:bulk-create
Bulk create LibraryParameterDefinition
PATCH
/library-parameter-definition:bulk-update
Bulk update LibraryParameterDefinition
limits 1
GET
/limits
Get the request count limits for each tier
Location 8
A Location represents a physical storage area in Benchling's inventory system, such as a freezer, refrigerator, shelf, room, or building. Locations form a hierarchy where each loc…
POST
/location
Create Location
GET
/location/items
List Location items
GET
/location/{location_id}
Get Location by ID
PATCH
/location/{location_id}
Update Location
POST
/location:batch-create
Batch create Location
PATCH
/location:batch-update
Batch update Location
POST
/location:bulk-create
Bulk create Location
PATCH
/location:bulk-update
Bulk update Location
LocationSchema 9
Defines the structure and metadata for a category of Locations in Benchling's inventory system. A LocationSchema specifies schema field definitions for capturing location-specific…
POST
/location-schema
Create LocationSchema
GET
/location-schema/items
List LocationSchema items
GET
/location-schema/{location_schema_id}
Get LocationSchema by ID
PATCH
/location-schema/{location_schema_id}
Update LocationSchema
GET
/location-schema/{location_schema_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/location-schema:batch-create
Batch create LocationSchema
PATCH
/location-schema:batch-update
Batch update LocationSchema
POST
/location-schema:bulk-create
Bulk create LocationSchema
PATCH
/location-schema:bulk-update
Bulk update LocationSchema
MatrixPlate 8
A MatrixPlate is a rack-style storage plate where Containers (tubes, vials) can be inserted into and removed from grid positions. Unlike FixedPlate or WellPlate where wells are pe…
POST
/matrix-plate
Create MatrixPlate
GET
/matrix-plate/items
List MatrixPlate items
GET
/matrix-plate/{matrix_plate_id}
Get MatrixPlate by ID
PATCH
/matrix-plate/{matrix_plate_id}
Update MatrixPlate
POST
/matrix-plate:batch-create
Batch create MatrixPlate
PATCH
/matrix-plate:batch-update
Batch update MatrixPlate
POST
/matrix-plate:bulk-create
Bulk create MatrixPlate
PATCH
/matrix-plate:bulk-update
Bulk update MatrixPlate
MatrixPlateSchema 9
Defines the structure and constraints for a category of MatrixPlates in Benchling's inventory system. A MatrixPlateSchema specifies the grid dimensions (height and width), an opti…
POST
/matrix-plate-schema
Create MatrixPlateSchema
GET
/matrix-plate-schema/items
List MatrixPlateSchema items
GET
/matrix-plate-schema/{matrix_plate_schema_id}
Get MatrixPlateSchema by ID
PATCH
/matrix-plate-schema/{matrix_plate_schema_id}
Update MatrixPlateSchema
GET
/matrix-plate-schema/{matrix_plate_schema_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/matrix-plate-schema:batch-create
Batch create MatrixPlateSchema
PATCH
/matrix-plate-schema:batch-update
Batch update MatrixPlateSchema
POST
/matrix-plate-schema:bulk-create
Bulk create MatrixPlateSchema
PATCH
/matrix-plate-schema:bulk-update
Bulk update MatrixPlateSchema
MixtureSchema 14
Defines the structure, field definitions, and configuration options for Mixtures.
POST
/mixture-schema
Create MixtureSchema
GET
/mixture-schema/items
List MixtureSchema items
GET
/mixture-schema/{mixture_schema_id}
Get MixtureSchema by ID
PATCH
/mixture-schema/{mixture_schema_id}
Update MixtureSchema
GET
/mixture-schema/{mixture_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/mixture-schema/{mixture_schema_id}/fieldsets/items
List Fieldset items
POST
/mixture-schema/{mixture_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/mixture-schema/{mixture_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/mixture-schema:batch-create
Batch create MixtureSchema
PATCH
/mixture-schema:batch-update
Batch update MixtureSchema
POST
/mixture-schema:bulk-create
Bulk create MixtureSchema
PATCH
/mixture-schema:bulk-update
Bulk update MixtureSchema
GET
/tasks/mixture-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/mixture-schema/set-field-definitions/{task_id}
Poll async task status
Mixture 3
A Mixture is a formulation entity in Benchling that represents a combination of ingredients with specified amounts. Mixtures are commonly used for buffers, media, reagent preparat…
GET
/mixture/items
List Mixture items
GET
/mixture/{mixture_id}
Get Mixture by ID
GET
/mixture/{mixture_id}/authors/items
List Principal items
Molecule 9
A Molecule represents a small molecule chemical compound in Benchling that is imported either as a MolFile or using SMILES (Simplified Molecular Input Line Entry System) notation.…
POST
/molecule
Create Molecule
GET
/molecule/items
List Molecule items
GET
/molecule/{molecule_id}
Get Molecule by ID
PATCH
/molecule/{molecule_id}
Update Molecule
GET
/molecule/{molecule_id}/authors/items
List Principal items
POST
/molecule:batch-create
Batch create Molecule
PATCH
/molecule:batch-update
Batch update Molecule
POST
/molecule:bulk-create
Bulk create Molecule
PATCH
/molecule:bulk-update
Bulk update Molecule
MoleculeSchema 14
Defines the structure, field definitions, and configuration options for Molecule schemas.
POST
/molecule-schema
Create MoleculeSchema
GET
/molecule-schema/items
List MoleculeSchema items
GET
/molecule-schema/{molecule_schema_id}
Get MoleculeSchema by ID
PATCH
/molecule-schema/{molecule_schema_id}
Update MoleculeSchema
GET
/molecule-schema/{molecule_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/molecule-schema/{molecule_schema_id}/fieldsets/items
List Fieldset items
POST
/molecule-schema/{molecule_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/molecule-schema/{molecule_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/molecule-schema:batch-create
Batch create MoleculeSchema
PATCH
/molecule-schema:batch-update
Batch update MoleculeSchema
POST
/molecule-schema:bulk-create
Bulk create MoleculeSchema
PATCH
/molecule-schema:bulk-update
Bulk update MoleculeSchema
GET
/tasks/molecule-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/molecule-schema/set-field-definitions/{task_id}
Poll async task status
NucleotideAlignment 9
Represents a multiple sequence alignment of nucleotide sequences (DNA or RNA). Nucleotide alignments are used to compare sequence reads against a reference template for verificati…
GET
/nucleotide-alignment/items
List NucleotideAlignment items
DELETE
/nucleotide-alignment/{nucleotide_alignment_id}
Delete NucleotideAlignment
GET
/nucleotide-alignment/{nucleotide_alignment_id}
Get NucleotideAlignment by ID
GET
/nucleotide-alignment/{nucleotide_alignment_id}/aligned-nucleotide-sequences/items
List AlignedNucleotideSequence items
POST
/nucleotide-alignment:batch-delete
Batch delete NucleotideAlignment
POST
/nucleotide-alignment:create-consensus-alignment
Create a consensus nucleotide alignment
POST
/nucleotide-alignment:create-template-alignment
Create a template nucleotide alignment
GET
/tasks/nucleotide-alignment/create-consensus-alignment/{task_id}
Poll async task status
GET
/tasks/nucleotide-alignment/create-template-alignment/{task_id}
Poll async task status
NucleotideMonomer 2
A building block component of modified oligonucleotides, representing a sugar, phosphate, or base subunit. Monomers are the chemical units that assemble to form nucleotides in the…
GET
/nucleotide-monomer/items
List NucleotideMonomer items
GET
/nucleotide-monomer/{nucleotide_monomer_id}
Get NucleotideMonomer by ID
Authentication 1
Endpoints for obtaining and managing OAuth2 access tokens.
POST
/oauth/token
Generate a token
OligoConjugate 9
An oligo conjugate is a therapeutic modality consisting of a single-stranded oligonucleotide backbone with one or more attached conjugate molecules. Common examples include antise…
POST
/oligo-conjugate
Create OligoConjugate
GET
/oligo-conjugate/items
List OligoConjugate items
GET
/oligo-conjugate/{oligo_conjugate_id}
Get OligoConjugate by ID
PATCH
/oligo-conjugate/{oligo_conjugate_id}
Update OligoConjugate
GET
/oligo-conjugate/{oligo_conjugate_id}/authors/items
List Principal items
POST
/oligo-conjugate:batch-create
Batch create OligoConjugate
PATCH
/oligo-conjugate:batch-update
Batch update OligoConjugate
POST
/oligo-conjugate:bulk-create
Bulk create OligoConjugate
PATCH
/oligo-conjugate:bulk-update
Bulk update OligoConjugate
OligoConjugateSchema 14
Defines the structure, field definitions, and configuration options for Oligo Conjugates.
POST
/oligo-conjugate-schema
Create OligoConjugateSchema
GET
/oligo-conjugate-schema/items
List OligoConjugateSchema items
GET
/oligo-conjugate-schema/{oligo_conjugate_schema_id}
Get OligoConjugateSchema by ID
PATCH
/oligo-conjugate-schema/{oligo_conjugate_schema_id}
Update OligoConjugateSchema
GET
/oligo-conjugate-schema/{oligo_conjugate_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/oligo-conjugate-schema/{oligo_conjugate_schema_id}/fieldsets/items
List Fieldset items
POST
/oligo-conjugate-schema/{oligo_conjugate_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/oligo-conjugate-schema/{oligo_conjugate_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/oligo-conjugate-schema:batch-create
Batch create OligoConjugateSchema
PATCH
/oligo-conjugate-schema:batch-update
Batch update OligoConjugateSchema
POST
/oligo-conjugate-schema:bulk-create
Bulk create OligoConjugateSchema
PATCH
/oligo-conjugate-schema:bulk-update
Bulk update OligoConjugateSchema
GET
/tasks/oligo-conjugate-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/oligo-conjugate-schema/set-field-definitions/{task_id}
Poll async task status
OligoDuplex 9
An oligo duplex is a therapeutic modality consisting of two complementary oligonucleotide strands (forward and reverse) with optional conjugate molecules attached to either strand…
POST
/oligo-duplex
Create OligoDuplex
GET
/oligo-duplex/items
List OligoDuplex items
GET
/oligo-duplex/{oligo_duplex_id}
Get OligoDuplex by ID
PATCH
/oligo-duplex/{oligo_duplex_id}
Update OligoDuplex
GET
/oligo-duplex/{oligo_duplex_id}/authors/items
List Principal items
POST
/oligo-duplex:batch-create
Batch create OligoDuplex
PATCH
/oligo-duplex:batch-update
Batch update OligoDuplex
POST
/oligo-duplex:bulk-create
Bulk create OligoDuplex
PATCH
/oligo-duplex:bulk-update
Bulk update OligoDuplex
OligoDuplexSchema 14
Defines the structure, field definitions, and configuration options for Oligo Duplexes.
POST
/oligo-duplex-schema
Create OligoDuplexSchema
GET
/oligo-duplex-schema/items
List OligoDuplexSchema items
GET
/oligo-duplex-schema/{oligo_duplex_schema_id}
Get OligoDuplexSchema by ID
PATCH
/oligo-duplex-schema/{oligo_duplex_schema_id}
Update OligoDuplexSchema
GET
/oligo-duplex-schema/{oligo_duplex_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/oligo-duplex-schema/{oligo_duplex_schema_id}/fieldsets/items
List Fieldset items
POST
/oligo-duplex-schema/{oligo_duplex_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/oligo-duplex-schema/{oligo_duplex_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/oligo-duplex-schema:batch-create
Batch create OligoDuplexSchema
PATCH
/oligo-duplex-schema:batch-update
Batch update OligoDuplexSchema
POST
/oligo-duplex-schema:bulk-create
Bulk create OligoDuplexSchema
PATCH
/oligo-duplex-schema:bulk-update
Bulk update OligoDuplexSchema
GET
/tasks/oligo-duplex-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/oligo-duplex-schema/set-field-definitions/{task_id}
Poll async task status
Organization 3
Represents a group of users within Benchling, typically corresponding to a company, department, or research group. Organizations provide a many-to-many relationship between users—…
GET
/organization/items
List Organization items
GET
/organization/{organization_id}
Get Organization by ID
GET
/organization/{organization_id}/memberships/items
List GroupMembership items
PipelineStepData 2
Represents actual data attached to an input or output slot of a PipelineStep during execution. Each PipelineStepData corresponds to a defined data shape (input or output) on the s…
GET
/pipeline-step-data/items
List PipelineStepData items
GET
/pipeline-step-data/{pipeline_step_data_id}
Get PipelineStepData by ID
PipelineStep 4
Represents a single operation node within a Pipeline's directed acyclic graph (DAG). Each step performs a specific transformation determined by its stepType (see PipelineStepType)…
GET
/pipeline-step/items
List PipelineStep items
GET
/pipeline-step/{pipeline_step_id}
Get PipelineStep by ID
GET
/pipeline-step/{pipeline_step_id}/input-step-datas/items
List PipelineStepData items
GET
/pipeline-step/{pipeline_step_id}/output-step-datas/items
List PipelineStepData items
PlateDesignTemplate 8
A named plate design template backed by a scratch plate that lives in a template collection. Plate design templates allow scratch plates to be organized and reused as templates.
POST
/plate-design-template
Create PlateDesignTemplate
GET
/plate-design-template/items
List PlateDesignTemplate items
GET
/plate-design-template/{plate_design_template_id}
Get PlateDesignTemplate by ID
PATCH
/plate-design-template/{plate_design_template_id}
Update PlateDesignTemplate
POST
/plate-design-template:batch-create
Batch create PlateDesignTemplate
PATCH
/plate-design-template:batch-update
Batch update PlateDesignTemplate
POST
/plate-design-template:bulk-create
Bulk create PlateDesignTemplate
PATCH
/plate-design-template:bulk-update
Bulk update PlateDesignTemplate
PlateSchema 3
Defines the structure and constraints for a category of Plates in Benchling's inventory system. A PlateSchema specifies the grid dimensions (height and width), the plate type (see…
GET
/plate-schema/items
List PlateSchema items
GET
/plate-schema/{plate_schema_id}
Get PlateSchema by ID
GET
/plate-schema/{plate_schema_id}/field-definitions/items
List SchemaFieldDefinition items
Plate 3
A Plate is a legacy unified type representing both well plates and tube racks in Benchling's inventory system. The type field (see PlateType) indicates whether this is a FIXEDPLAT…
GET
/plate/items
List Plate items
GET
/plate/{plate_id}
Get Plate by ID
GET
/plate/{plate_id}/wells/items
List Container items
Policy 2
Defines a named set of permissions that can be assigned to users or groups through collaborations. Policies contain PolicyStatements that specify allowed actions on different item…
GET
/policy/items
List Policy items
GET
/policy/{policy_id}
Get Policy by ID
PredictionBatch 6
Represents an execution of a Model Hub model against multiple data inputs (resulting in multiple Predictions). A PredictionBatch tracks the input configuration, execution status,…
POST
/prediction-batch
Create PredictionBatch
GET
/prediction-batch/items
List PredictionBatch items
GET
/prediction-batch/{prediction_batch_id}
Get PredictionBatch by ID
GET
/prediction-batch/{prediction_batch_id}/prediction-jobs/items
List PredictionJob items
POST
/prediction-batch:batch-create
Batch create PredictionBatch
POST
/prediction-batch:bulk-create
Bulk create PredictionBatch
PredictionJob 2
Represents a single prediction within a PredictionBatch. Each PredictionJob captures the input configuration for one prediction and its association with input components (e.g., AA…
GET
/prediction-job/items
List PredictionJob items
GET
/prediction-job/{prediction_job_id}
Get PredictionJob by ID
Printer 2
A Printer represents a network-connected label printer configured in Benchling for printing barcode labels on inventory items. Printers are associated with a Registry and work wit…
GET
/printer/items
List Printer items
GET
/printer/{printer_id}
Get Printer by ID
ProcedureFlowchartConfigVersionProxy 3
Represents a snapshot of a procedure's flowchart configuration at a specific point in time. The flowchart defines the structure of a procedure as a directed graph, where nodes rep…
GET
/procedure-flowchart-config-version-proxy/items
List ProcedureFlowchartConfigVersionProxy items
GET
/procedure-flowchart-config-version-proxy/{procedure_flowchart_config_version_proxy_id}
Get ProcedureFlowchartConfigVersionProxy by ID
GET
/procedure-flowchart-config-version-proxy/{procedure_flowchart_config_version_proxy_id}/nodes/items
List ProcedureMethodDefinitionVersion items
ProcedureFlowchartVersion 3
An immutable snapshot of a procedure's flowchart structure at a specific point in time. Each version contains the complete graph of method steps (see nodes and ProcedureMethodDefi…
GET
/procedure-flowchart-version/items
List ProcedureFlowchartVersion items
GET
/procedure-flowchart-version/{procedure_flowchart_version_id}
Get ProcedureFlowchartVersion by ID
GET
/procedure-flowchart-version/{procedure_flowchart_version_id}/nodes/items
List ProcedureMethodDefinitionVersion items
ProcedureFlowchart 2
Contains the flowchart configuration for a Procedure or TemplateCollection. A ProcedureFlowchart acts as a container for flowchart versions (see ProcedureFlowchartVersion), tracki…
GET
/procedure-flowchart/items
List ProcedureFlowchart items
GET
/procedure-flowchart/{procedure_flowchart_id}
Get ProcedureFlowchart by ID
ProcedureMethodDefinitionVersion 2
A versioned method within a procedure flowchart. Methods are the building blocks of procedures, representing discrete experimental operations that scientists perform. Each method…
GET
/procedure-method-definition-version/items
List ProcedureMethodDefinitionVersion items
GET
/procedure-method-definition-version/{procedure_method_definition_version_id}
Get ProcedureMethodDefinitionVersion by ID
ProcedureMethodExecutionInstanceAssociation 7
Links two method execution instances across procedure runs to represent an intended connection within a study. This allows scientists to coordinate their analyses across runs, eve…
POST
/procedure-method-execution-instance-association
Create ProcedureMethodExecutionInstanceAssociation
GET
/procedure-method-execution-instance-association/items
List ProcedureMethodExecutionInstanceAssociation items
DELETE
/procedure-method-execution-instance-association/{procedure_method_execution_instance_association_id}
Delete ProcedureMethodExecutionInstanceAssociation
GET
/procedure-method-execution-instance-association/{procedure_method_execution_instance_association_id}
Get ProcedureMethodExecutionInstanceAssociation by ID
POST
/procedure-method-execution-instance-association:batch-create
Batch create ProcedureMethodExecutionInstanceAssociation
POST
/procedure-method-execution-instance-association:batch-delete
Batch delete ProcedureMethodExecutionInstanceAssociation
POST
/procedure-method-execution-instance-association:bulk-create
Bulk create ProcedureMethodExecutionInstanceAssociation
ProcedureMethodExecutionInstance 10
An instance of a method being executed within a procedure run. When a scientist runs a procedure, each method in the flowchart becomes a ProcedureMethodExecutionInstance that trac…
GET
/procedure-method-execution-instance/items
List ProcedureMethodExecutionInstance items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}
Get ProcedureMethodExecutionInstance by ID
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/data-parameter-actual-values/items
List ProcedureParameterMeasuredValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/data-parameter-confirmation-values/items
List ProcedureParameterConfirmationValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/data-parameter-planned-values/items
List ProcedureParameterPlannedValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/equipment-confirmation-values/items
List ProcedureParameterConfirmationValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/equipment-planned-values/items
List ProcedureParameterPlannedValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/material-input-confirmation-values/items
List ProcedureParameterConfirmationValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/material-input-planned-values/items
List ProcedureParameterPlannedValue items
GET
/procedure-method-execution-instance/{procedure_method_execution_instance_id}/material-output-confirmation-values/items
List ProcedureParameterConfirmationValue items
ProcedureParameterConfirmationValue 2
Records a scientist's confirmation of a parameter value during procedure execution. When running a procedure, scientists confirm that inputs (such as materials, equipment, or data…
GET
/procedure-parameter-confirmation-value/items
List ProcedureParameterConfirmationValue items
GET
/procedure-parameter-confirmation-value/{procedure_parameter_confirmation_value_id}
Get ProcedureParameterConfirmationValue by ID
ProcedureParameterMeasuredValue 2
Records the actual measured or observed value for a parameter during procedure execution. Scientists enter measured values after performing an experimental step—for example, recor…
GET
/procedure-parameter-measured-value/items
List ProcedureParameterMeasuredValue items
GET
/procedure-parameter-measured-value/{procedure_parameter_measured_value_id}
Get ProcedureParameterMeasuredValue by ID
ProcedureParameterPlannedValue 2
Stores the expected or planned value for a parameter, set during procedure setup or run planning. Used to specify anticipated inputs before execution begins—for example, the targe…
GET
/procedure-parameter-planned-value/items
List ProcedureParameterPlannedValue items
GET
/procedure-parameter-planned-value/{procedure_parameter_planned_value_id}
Get ProcedureParameterPlannedValue by ID
ProcedureParameterVersion 2
A versioned definition of a procedure parameter. Each version specifies the parameter's name, description, data type configuration (dataType), and how values are entered (confirma…
GET
/procedure-parameter-version/items
List ProcedureParameterVersion items
GET
/procedure-parameter-version/{procedure_parameter_version_id}
Get ProcedureParameterVersion by ID
ProcedureParameter 2
Represents a parameter entity within a procedure template. Parameters define the data, materials, or equipment that scientists interact with during procedure execution. The parame…
GET
/procedure-parameter/items
List ProcedureParameter items
GET
/procedure-parameter/{procedure_parameter_id}
Get ProcedureParameter by ID
ProcedureRunConditionReplicate 2
A replicate of a ProcedureRunCondition, representing one execution of a condition's configuration. Scientists often run the same experimental condition multiple times to obtain st…
GET
/procedure-run-condition-replicate/items
List ProcedureRunConditionReplicate items
GET
/procedure-run-condition-replicate/{procedure_run_condition_replicate_id}
Get ProcedureRunConditionReplicate by ID
ProcedureRunCondition 3
A ProcedureRunCondition represents a configuration of the methods of a Procedure that is being executed within a ProcedureRun. The values associated with the ProcedureRunCondition…
GET
/procedure-run-condition/items
List ProcedureRunCondition items
GET
/procedure-run-condition/{procedure_run_condition_id}
Get ProcedureRunCondition by ID
GET
/procedure-run-condition/{procedure_run_condition_id}/procedure-run-condition-replicates/items
List ProcedureRunConditionReplicate items
ProcedureRunPlan 11
A draft experiment plan that can be promoted to a ProcedureRun for execution. Scientists use run plans to configure experimental conditions, parameter values, and replicates befor…
POST
/procedure-run-plan
Create ProcedureRunPlan
GET
/procedure-run-plan/items
List ProcedureRunPlan items
GET
/procedure-run-plan/{procedure_run_plan_id}
Get ProcedureRunPlan by ID
PATCH
/procedure-run-plan/{procedure_run_plan_id}
Update ProcedureRunPlan
GET
/procedure-run-plan/{procedure_run_plan_id}/procedure-run-plan-conditions/items
List ProcedureRunPlanCondition items
POST
/procedure-run-plan:batch-create
Batch create ProcedureRunPlan
PATCH
/procedure-run-plan:batch-update
Batch update ProcedureRunPlan
POST
/procedure-run-plan:bulk-create
Bulk create ProcedureRunPlan
PATCH
/procedure-run-plan:bulk-update
Bulk update ProcedureRunPlan
POST
/procedure-run-plan:promote
Turn procedure run plans into active procedure runs. Plans must not already be converted. Returns an async task — poll the task endpoint for completion and the created procedure run IDs
GET
/tasks/procedure-run-plan/promote/{task_id}
Poll async task status
ProcedureRunPlanCondition 8
A planned experimental condition within a ProcedureRunPlan, representing how a procedure's methods will be configured when the plan is promoted to an actual ProcedureRun. Each con…
POST
/procedure-run-plan-condition
Create ProcedureRunPlanCondition
GET
/procedure-run-plan-condition/items
List ProcedureRunPlanCondition items
GET
/procedure-run-plan-condition/{procedure_run_plan_condition_id}
Get ProcedureRunPlanCondition by ID
PATCH
/procedure-run-plan-condition/{procedure_run_plan_condition_id}
Update ProcedureRunPlanCondition
POST
/procedure-run-plan-condition:batch-create
Batch create ProcedureRunPlanCondition
PATCH
/procedure-run-plan-condition:batch-update
Batch update ProcedureRunPlanCondition
POST
/procedure-run-plan-condition:bulk-create
Bulk create ProcedureRunPlanCondition
PATCH
/procedure-run-plan-condition:bulk-update
Bulk update ProcedureRunPlanCondition
ProcedureRun 4
An active execution of a procedure template. Created when scientists start running an experiment based on a Procedure. Contains experimental conditions (conditions via ProcedureRu…
GET
/procedure-run/items
List ProcedureRun items
GET
/procedure-run/{procedure_run_id}
Get ProcedureRun by ID
GET
/procedure-run/{procedure_run_id}/conditions/items
List ProcedureRunCondition items
GET
/procedure-run/{procedure_run_id}/method-execution-instances/items
List ProcedureMethodExecutionInstance items
ProcedureStepDefinitionVersion 2
A versioned definition of a procedure step within a procedure flowchart. Steps represent documentation or instructions that guide scientists through a procedure but do not collect…
GET
/procedure-step-definition-version/items
List ProcedureStepDefinitionVersion items
GET
/procedure-step-definition-version/{procedure_step_definition_version_id}
Get ProcedureStepDefinitionVersion by ID
ProcedureStepExecutionInstance 2
An execution instance of a procedure step within a ProcedureMethodExecutionInstance. Created when a procedure run is started, representing a step where scientists can document the…
GET
/procedure-step-execution-instance/items
List ProcedureStepExecutionInstance items
GET
/procedure-step-execution-instance/{procedure_step_execution_instance_id}
Get ProcedureStepExecutionInstance by ID
Procedure 2
A reusable template that defines a structured experimental workflow. Procedures specify a sequence of method steps (see ProcedureMethodDefinitionVersion) connected in a flowchart…
GET
/procedure/items
List Procedure items
GET
/procedure/{procedure_id}
Get Procedure by ID
Project 10
A top-level organizational container in Benchling that groups related work and controls access permissions. Projects contain Folders (see Folder) which in turn hold entities, note…
POST
/project
Create Project
GET
/project/items
List Project items
GET
/project/{project_id}
Get Project by ID
PATCH
/project/{project_id}
Update Project
GET
/project/{project_id}/collaborations/items
List Collaboration items
GET
/project/{project_id}/review-processes/items
List ReviewProcess items
POST
/project:batch-create
Batch create Project
PATCH
/project:batch-update
Batch update Project
POST
/project:bulk-create
Bulk create Project
PATCH
/project:bulk-update
Bulk update Project
Protein 14
A Protein is a complex biomolecule entity in Benchling representing immunoglobulins or related therapeutic proteins like T-cell receptors. Proteins are defined by an ProteinFormat…
POST
/protein
Create Protein
GET
/protein/items
List Protein items
GET
/protein/{protein_id}
Get Protein by ID
PATCH
/protein/{protein_id}
Update Protein
GET
/protein/{protein_id}/authors/items
List Principal items
GET
/protein/{protein_id}/full-history/items
List ProteinVersion items
GET
/protein/{protein_id}/history/items
List ProteinVersion items
POST
/protein:batch-create
Batch create Protein
PATCH
/protein:batch-update
Batch update Protein
POST
/protein:bulk-create
Bulk create Protein
PATCH
/protein:bulk-update
Bulk update Protein
POST
/proteins:bulk-create-and-register-proteins-and-components
Create and register proteins and components
GET
/tasks/bulk-create-and-register-proteins-and-components/{task_id}
Get bulk-create-and-register-proteins-and-components task status
GET
/tasks/bulk-create-and-register-proteins-and-components/{task_id}/results
Get bulk-create-and-register-proteins-and-components task results
ProteinFormat 8
A ProteinFormat defines the structural template for a class of proteins, specifying the arrangement of chains and domains. Formats can be built-in (e.g., IgG1, Fab, scFv) or custo…
POST
/protein-format
Create ProteinFormat
GET
/protein-format/items
List ProteinFormat items
GET
/protein-format/{protein_format_id}
Get ProteinFormat by ID
PATCH
/protein-format/{protein_format_id}
Update ProteinFormat
POST
/protein-format:batch-create
Batch create ProteinFormat
PATCH
/protein-format:batch-update
Batch update ProteinFormat
POST
/protein-format:bulk-create
Bulk create ProteinFormat
PATCH
/protein-format:bulk-update
Bulk update ProteinFormat
ProteinSchema 14
Defines the structure, field definitions, and configuration options for Proteins.
POST
/protein-schema
Create ProteinSchema
GET
/protein-schema/items
List ProteinSchema items
GET
/protein-schema/{protein_schema_id}
Get ProteinSchema by ID
PATCH
/protein-schema/{protein_schema_id}
Update ProteinSchema
GET
/protein-schema/{protein_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/protein-schema/{protein_schema_id}/fieldsets/items
List Fieldset items
POST
/protein-schema/{protein_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/protein-schema/{protein_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/protein-schema:batch-create
Batch create ProteinSchema
PATCH
/protein-schema:batch-update
Batch update ProteinSchema
POST
/protein-schema:bulk-create
Bulk create ProteinSchema
PATCH
/protein-schema:bulk-update
Bulk update ProteinSchema
GET
/tasks/protein-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/protein-schema/set-field-definitions/{task_id}
Poll async task status
ProteinVersion 2
A historical snapshot of an Protein at a specific point in time, preserving the complete structural state including domains, chains, and HELM notation. Protein versions form a lin…
GET
/protein-version/items
List ProteinVersion items
GET
/protein-version/{protein_version_id}
Get ProteinVersion by ID
Reaction 6
A Chemical Reaction is a process where molecules are transformed into new molecules.
GET
/reaction/items
List Reaction items
GET
/reaction/{reaction_id}
Get Reaction by ID
PATCH
/reaction/{reaction_id}
Update Reaction
GET
/reaction/{reaction_id}/authors/items
List Principal items
PATCH
/reaction:batch-update
Batch update Reaction
PATCH
/reaction:bulk-update
Bulk update Reaction
Registry 2
A centralized, validated repository for entities and inventory items within an organization. The registry serves as the source of truth for registered items—entities placed in the…
GET
/registry/items
List Registry items
GET
/registry/{registry_id}
Get Registry by ID
RequestV2Definition 8
A reusable template that defines the structure and configuration for requests in Benchling. Also known as a "Request Template" in the UI. Each RequestV2Definition specifies a temp…
POST
/request-v2-definition
Create RequestV2Definition
GET
/request-v2-definition/items
List RequestV2Definition items
GET
/request-v2-definition/{request_v2_definition_id}
Get RequestV2Definition by ID
PATCH
/request-v2-definition/{request_v2_definition_id}
Update RequestV2Definition
POST
/request-v2-definition:batch-create
Batch create RequestV2Definition
PATCH
/request-v2-definition:batch-update
Batch update RequestV2Definition
POST
/request-v2-definition:bulk-create
Bulk create RequestV2Definition
PATCH
/request-v2-definition:bulk-update
Bulk update RequestV2Definition
RequestV2Submission 3
A workflow request submitted from a RequestV2Definition (known as "Request Template" in the UI). When a request is submitted (status transitions to SENT), a WorkflowTaskGroup is a…
GET
/request-v2-submission/items
List RequestV2Submission items
GET
/request-v2-submission/{request_v2_submission_id}
Get RequestV2Submission by ID
GET
/request-v2-submission/{request_v2_submission_id}/authors/items
List Principal items
Result 8
A Result represents a single row of experimental measurement data in Benchling's lab automation system. Results conform to a ResultSchema that defines their field structure, enabl…
POST
/result
Create Result
GET
/result/items
List Result items
GET
/result/{result_id}
Get Result by ID
PATCH
/result/{result_id}
Update Result
POST
/result:batch-create
Batch create Result
PATCH
/result:batch-update
Batch update Result
POST
/result:bulk-create
Bulk create Result
PATCH
/result:bulk-update
Bulk update Result
ResultSchema 3
Defines the structure and metadata fields for a category of assay Results in Benchling's lab automation system. A ResultSchema specifies the field definitions that capture measure…
GET
/result-schema/items
List ResultSchema items
GET
/result-schema/{result_schema_id}
Get ResultSchema by ID
GET
/result-schema/{result_schema_id}/field-definitions/items
List SchemaFieldDefinition items
ReviewChange 2
Represents a single action taken within a review. ReviewChanges form an ordered history of all changes made to a review, including status transitions, reviewer assignments, and co…
GET
/review-change/items
List ReviewChange items
GET
/review-change/{review_change_id}
Get ReviewChange by ID
ReviewProcessStage 2
A single stage within a ReviewProcess that defines a required step in the review workflow. Each stage specifies what action reviewers must take (see ReviewProcessActionType), who…
GET
/review-process-stage/items
List ReviewProcessStage items
GET
/review-process-stage/{review_process_stage_id}
Get ReviewProcessStage by ID
ReviewProcess 3
Defines a review process configuration that specifies how entries and other reviewable items should be reviewed. A ReviewProcess belongs to an Organization and can be associated w…
GET
/review-process/items
List ReviewProcess items
GET
/review-process/{review_process_id}
Get ReviewProcess by ID
GET
/review-process/{review_process_id}/projects/items
List Project items
Review 3
Represents an active or completed review of a reviewable item such as an Entry or StageEntry. A Review tracks the overall status, the assigned reviewers (see Reviewer), and links…
GET
/review/items
List Review items
GET
/review/{review_id}
Get Review by ID
GET
/review/{review_id}/review-history/items
List ReviewChange items
RnaOligo 10
Represents a short single-stranded RNA oligonucleotide in Benchling's molecular biology platform. RNA oligos are synthetic sequences used in applications such as RNA interference…
POST
/rna-oligo
Create RnaOligo
GET
/rna-oligo/items
List RnaOligo items
GET
/rna-oligo/{rna_oligo_id}
Get RnaOligo by ID
PATCH
/rna-oligo/{rna_oligo_id}
Update RnaOligo
GET
/rna-oligo/{rna_oligo_id}/authors/items
List Principal items
GET
/rna-oligo/{rna_oligo_id}/modified-nucleotides/items
List ModifiedNucleotide items
POST
/rna-oligo:batch-create
Batch create RnaOligo
PATCH
/rna-oligo:batch-update
Batch update RnaOligo
POST
/rna-oligo:bulk-create
Bulk create RnaOligo
PATCH
/rna-oligo:bulk-update
Bulk update RnaOligo
RnaOligoSchema 14
Defines the structure, field definitions, and configuration options for RNA oligos.
POST
/rna-oligo-schema
Create RnaOligoSchema
GET
/rna-oligo-schema/items
List RnaOligoSchema items
GET
/rna-oligo-schema/{rna_oligo_schema_id}
Get RnaOligoSchema by ID
PATCH
/rna-oligo-schema/{rna_oligo_schema_id}
Update RnaOligoSchema
GET
/rna-oligo-schema/{rna_oligo_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/rna-oligo-schema/{rna_oligo_schema_id}/fieldsets/items
List Fieldset items
POST
/rna-oligo-schema/{rna_oligo_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/rna-oligo-schema/{rna_oligo_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/rna-oligo-schema:batch-create
Batch create RnaOligoSchema
PATCH
/rna-oligo-schema:batch-update
Batch update RnaOligoSchema
POST
/rna-oligo-schema:bulk-create
Bulk create RnaOligoSchema
PATCH
/rna-oligo-schema:bulk-update
Bulk update RnaOligoSchema
GET
/tasks/rna-oligo-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/rna-oligo-schema/set-field-definitions/{task_id}
Poll async task status
RnaSequence 11
Represents an RNA sequence in Benchling's molecular biology platform. An RnaSequence stores the nucleotide bases (using A, C, G, U) along with annotations marking functional regio…
POST
/rna-sequence
Create RnaSequence
GET
/rna-sequence/items
List RnaSequence items
GET
/rna-sequence/{rna_sequence_id}
Get RnaSequence by ID
PATCH
/rna-sequence/{rna_sequence_id}
Update RnaSequence
GET
/rna-sequence/{rna_sequence_id}/authors/items
List Principal items
GET
/rna-sequence/{rna_sequence_id}/modified-nucleotides/items
List ModifiedNucleotide items
GET
/rna-sequence/{rna_sequence_id}/parts/items
List RnaPart items
POST
/rna-sequence:batch-create
Batch create RnaSequence
PATCH
/rna-sequence:batch-update
Batch update RnaSequence
POST
/rna-sequence:bulk-create
Bulk create RnaSequence
PATCH
/rna-sequence:bulk-update
Bulk update RnaSequence
RnaSequenceSchema 14
Defines the structure, field definitions, and configuration options for RNA sequences
POST
/rna-sequence-schema
Create RnaSequenceSchema
GET
/rna-sequence-schema/items
List RnaSequenceSchema items
GET
/rna-sequence-schema/{rna_sequence_schema_id}
Get RnaSequenceSchema by ID
PATCH
/rna-sequence-schema/{rna_sequence_schema_id}
Update RnaSequenceSchema
GET
/rna-sequence-schema/{rna_sequence_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/rna-sequence-schema/{rna_sequence_schema_id}/fieldsets/items
List Fieldset items
POST
/rna-sequence-schema/{rna_sequence_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/rna-sequence-schema/{rna_sequence_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/rna-sequence-schema:batch-create
Batch create RnaSequenceSchema
PATCH
/rna-sequence-schema:batch-update
Batch update RnaSequenceSchema
POST
/rna-sequence-schema:bulk-create
Bulk create RnaSequenceSchema
PATCH
/rna-sequence-schema:bulk-update
Bulk update RnaSequenceSchema
GET
/tasks/rna-sequence-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/rna-sequence-schema/set-field-definitions/{task_id}
Poll async task status
RunSchema 5
Defines the structure and automation configuration for a category of Runs in Benchling's lab automation system. A RunSchema specifies field definitions for run metadata, input gen…
GET
/run-schema/items
List RunSchema items
GET
/run-schema/{run_schema_id}
Get RunSchema by ID
GET
/run-schema/{run_schema_id}/automation-input-file-configs/items
List AutomationInputFileConfig items
GET
/run-schema/{run_schema_id}/automation-output-file-configs/items
List AutomationOutputFileConfig items
GET
/run-schema/{run_schema_id}/field-definitions/items
List SchemaFieldDefinition items
Run 2
A Run represents an execution instance of a lab automation workflow in Benchling, capturing the inputs, outputs, and metadata for a single assay or instrument operation. Runs conf…
GET
/run/items
List Run items
GET
/run/{run_id}
Get Run by ID
ScratchFile 9
A ScratchFile represents raw file content used as intermediate input or output of pipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surfaced in the Data Cat…
POST
/scratch-file
Create ScratchFile
GET
/scratch-file/items
List ScratchFile items
GET
/scratch-file/{scratch_file_id}
Get ScratchFile by ID
PATCH
/scratch-file/{scratch_file_id}
Update ScratchFile
POST
/scratch-file:batch-create
Batch create ScratchFile
PATCH
/scratch-file:batch-update
Batch update ScratchFile
POST
/scratch-file:bulk-create
Bulk create ScratchFile
PATCH
/scratch-file:bulk-update
Bulk update ScratchFile
POST
/scratch-file:create-and-upload
Create a ScratchFile from either uploaded contents or an existing S3 location. Provide exactly one of contents (with a filename, up to 10 MiB of UTF-8 sent as an application/json body) or s3Location…
ScratchPlate 12
A plate design or record used for designing, tracking, and analyzing experimental plates outside of the inventory. Scratch plates are the working surface for plate-based workflows…
POST
/scratch-plate
Create ScratchPlate
GET
/scratch-plate/items
List ScratchPlate items
GET
/scratch-plate/{scratch_plate_id}
Get ScratchPlate by ID
PATCH
/scratch-plate/{scratch_plate_id}
Update ScratchPlate
POST
/scratch-plate:batch-create
Batch create ScratchPlate
PATCH
/scratch-plate:batch-update
Batch update ScratchPlate
POST
/scratch-plate:bulk-create
Bulk create ScratchPlate
POST
/scratch-plate:bulk-put-in-inventory
Create a registry plate from each scratch plate, populating wells from the scratch plate's label and content layers and any column mappings. Each item targets a plate schema (explicit or inherited fr…
PATCH
/scratch-plate:bulk-update
Bulk update ScratchPlate
POST
/scratch-plate:transfer
Create destination scratch plate(s) by transferring content out of existing source plates. Each move is recorded as a destinationtransfer on the child and a sourcetransfer on the source. The source p…
POST
/scratch-plate:transfer-async
Asynchronously create destination scratch plate(s) by transferring content out of existing source plates, alongside a copy of each source holding what remained.
GET
/tasks/scratch-plate/transfer-async/{task_id}
Poll async task status
Search 1
POST
/search
Search across Benchling objects
ServicePrincipal 2
Represents a non-human identity used for system integrations and automated processes within Benchling. Service principals act as the identity for service accounts that perform act…
GET
/service-principal/items
List ServicePrincipal items
GET
/service-principal/{service_principal_id}
Get ServicePrincipal by ID
SqlDashboardBlock 5
Represents a single query and visualization pane within a SqlDashboard. Each block contains a SQL query (sqlQuery) that runs against the Benchling data warehouse, along with a Blo…
GET
/sql-dashboard-block/items
List SqlDashboardBlock items
GET
/sql-dashboard-block/{sql_dashboard_block_id}
Get SqlDashboardBlock by ID
PATCH
/sql-dashboard-block/{sql_dashboard_block_id}
Update SqlDashboardBlock
PATCH
/sql-dashboard-block:batch-update
Batch update SqlDashboardBlock
PATCH
/sql-dashboard-block:bulk-update
Bulk update SqlDashboardBlock
SqlDashboard 3
A SqlDashboard is a configurable analytics page that displays one or more SQL-driven visualizations within Benchling Insights. Dashboards belong to a Project and contain ordered b…
GET
/sql-dashboard/items
List SqlDashboard items
GET
/sql-dashboard/{sql_dashboard_id}
Get SqlDashboard by ID
GET
/sql-dashboard/{sql_dashboard_id}/blocks/items
List SqlDashboardBlock items
StageEntry 4
A StageEntry is an Entry that is associated with a specific stage in a legacy Workflow. Unlike regular Entries which exist independently in folders, StageEntries are created as pa…
GET
/stage-entry/items
List StageEntry items
GET
/stage-entry/{stage_entry_id}
Get StageEntry by ID
GET
/stage-entry/{stage_entry_id}/applicable-review-processes/items
List ReviewProcess items
GET
/stage-entry/{stage_entry_id}/authors/items
List Principal items
Study 9
A structured unit used to plan and organize research in Benchling. Each study progresses through phases (see StudyPhase) sequentially from design to execution to completion. The c…
POST
/study
Create Study
GET
/study/items
List Study items
GET
/study/{study_id}
Get Study by ID
PATCH
/study/{study_id}
Update Study
GET
/study/{study_id}/authors/items
List Principal items
POST
/study:batch-create
Batch create Study
PATCH
/study:batch-update
Batch update Study
POST
/study:bulk-create
Bulk create Study
PATCH
/study:bulk-update
Bulk update Study
StudyItemAssociation 7
Represents the link between a Study and a Studyable item (such as entities or molecules). Each association is identified by id and links a specific study to a specific item, and r…
POST
/study-item-association
Create StudyItemAssociation
GET
/study-item-association/items
List StudyItemAssociation items
DELETE
/study-item-association/{study_item_association_id}
Delete StudyItemAssociation
GET
/study-item-association/{study_item_association_id}
Get StudyItemAssociation by ID
POST
/study-item-association:batch-create
Batch create StudyItemAssociation
POST
/study-item-association:batch-delete
Batch delete StudyItemAssociation
POST
/study-item-association:bulk-create
Bulk create StudyItemAssociation
StudySchema 10
A configuration template that defines the structure and behavior of Studies within an organization. Each StudySchema specifies the studyType, which determines available features a…
POST
/study-schema
Create StudySchema
GET
/study-schema/items
List StudySchema items
GET
/study-schema/{study_schema_id}
Get StudySchema by ID
PATCH
/study-schema/{study_schema_id}
Update StudySchema
GET
/study-schema/{study_schema_id}/entry-templates/items
List EntryTemplate items
GET
/study-schema/{study_schema_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/study-schema:batch-create
Batch create StudySchema
PATCH
/study-schema:batch-update
Batch update StudySchema
POST
/study-schema:bulk-create
Bulk create StudySchema
PATCH
/study-schema:bulk-update
Bulk update StudySchema
Tasks 6
GET
/tasks/agents/{task_id}
Get an agent task
GET
/tasks/bulk-export/{task_id}
Get bulk export task status
GET
/tasks/bulk-export/{task_id}/successful-results
Get bulk export task result
GET
/tasks/bulk/{task_id}
Get bulk task status
GET
/tasks/bulk/{task_id}/errors
Get bulk task errors
GET
/tasks/bulk/{task_id}/successful-results
Get bulk task results
Team 3
Represents a subgroup of users within an Organization, enabling finer-grained user management and data sharing. Teams belong to exactly one organization, and users may only join a…
GET
/team/items
List Team items
GET
/team/{team_id}
Get Team by ID
GET
/team/{team_id}/memberships/items
List GroupMembership items
TemplateCollection 3
A container that organizes related templates, subtemplates, and other template-like items. Template Collections provide a way to group and manage reusable content that teams use t…
GET
/template-collection/items
List TemplateCollection items
GET
/template-collection/{template_collection_id}
Get TemplateCollection by ID
GET
/template-collection/{template_collection_id}/items/items
List TemplateCollectible items
TestDefinition 8
A Test Definition is a configuration object that specifies a type of test or assay that can be ordered against samples. Each Test Definition is associated with a ResultSchema that…
POST
/test-definition
Create TestDefinition
GET
/test-definition/items
List TestDefinition items
GET
/test-definition/{test_definition_id}
Get TestDefinition by ID
PATCH
/test-definition/{test_definition_id}
Update TestDefinition
POST
/test-definition:batch-create
Batch create TestDefinition
PATCH
/test-definition:batch-update
Batch update TestDefinition
POST
/test-definition:bulk-create
Bulk create TestDefinition
PATCH
/test-definition:bulk-update
Bulk update TestDefinition
TestOrder 2
A Test Order represents an individual request to perform a specific test on a sample. Each Test Order references a TestDefinition that specifies what type of test to perform, and…
GET
/test-order/items
List TestOrder items
GET
/test-order/{test_order_id}
Get TestOrder by ID
Unit 8
A Unit is a specific measure of a physical quantity within Benchling's tenant-specific unit dictionary, used to capture and convert scientific measurements across the platform. Ea…
POST
/unit
Create Unit
GET
/unit/items
List Unit items
GET
/unit/{unit_id}
Get Unit by ID
PATCH
/unit/{unit_id}
Update Unit
POST
/unit:batch-create
Batch create Unit
PATCH
/unit:batch-update
Batch update Unit
POST
/unit:bulk-create
Bulk create Unit
PATCH
/unit:bulk-update
Bulk update Unit
UnitType 9
A UnitType is a dimensional category that groups inter-convertible Unit objects within Benchling's tenant-specific unit dictionary. Examples include Volume, Mass, Time, Molar Conc…
POST
/unit-type
Create UnitType
GET
/unit-type/items
List UnitType items
GET
/unit-type/{unit_type_id}
Get UnitType by ID
PATCH
/unit-type/{unit_type_id}
Update UnitType
GET
/unit-type/{unit_type_id}/units/items
List Unit items
POST
/unit-type:batch-create
Batch create UnitType
PATCH
/unit-type:batch-update
Batch update UnitType
POST
/unit-type:bulk-create
Bulk create UnitType
PATCH
/unit-type:bulk-update
Bulk update UnitType
User 2
Represents a human user in Benchling who can log in, perform actions, and own data. Users belong to one or more Organizations and may be members of Teams within those organization…
GET
/user/items
List User items
GET
/user/{user_id}
Get User by ID
WarehouseCredential 6
Represents credentials for connecting to Benchling's data warehouse, enabling users to query data using SQL tools like database clients or BI platforms. This includes all warehous…
GET
/warehouse-credential/items
List WarehouseCredential items
GET
/warehouse-credential/{warehouse_credential_id}
Get WarehouseCredential by ID
PATCH
/warehouse-credential/{warehouse_credential_id}
Update WarehouseCredential
PATCH
/warehouse-credential:batch-update
Batch update WarehouseCredential
PATCH
/warehouse-credential:bulk-update
Bulk update WarehouseCredential
POST
/warehouse-credential:create-warehouse-credential
Create a new WarehouseCredential. Generates a username and password, provisions the credential in the warehouse, and returns the one-time password.
WarehouseCustomView 2
A custom SQL view created by users in Benchling's data warehouse, allowing them to define reusable queries that can be accessed like tables. Views appear in a dedicated schema and…
GET
/warehouse-custom-view/items
List WarehouseCustomView items
GET
/warehouse-custom-view/{warehouse_custom_view_id}
Get WarehouseCustomView by ID
WellPlate 9
A WellPlate is a multi-well plate in Benchling's inventory system where wells are permanently fixed to the plate structure. This is the standard plate type for laboratory multi-we…
POST
/well-plate
Create WellPlate
GET
/well-plate/items
List WellPlate items
GET
/well-plate/{well_plate_id}
Get WellPlate by ID
PATCH
/well-plate/{well_plate_id}
Update WellPlate
GET
/well-plate/{well_plate_id}/positions/items
List WellPlatePosition items
POST
/well-plate:batch-create
Batch create WellPlate
PATCH
/well-plate:batch-update
Batch update WellPlate
POST
/well-plate:bulk-create
Bulk create WellPlate
PATCH
/well-plate:bulk-update
Bulk update WellPlate
WellPlatePosition 2
Represents a single well within a WellPlate, functioning as a fixed container at a specific grid position. Each WellPlatePosition has coordinates identifying its row and column, c…
GET
/well-plate-position/items
List WellPlatePosition items
GET
/well-plate-position/{well_plate_position_id}
Get WellPlatePosition by ID
WellPlateSchema 9
Defines the structure and constraints for a category of WellPlates in Benchling's inventory system. A WellPlateSchema specifies the grid dimensions (height and width) determining…
POST
/well-plate-schema
Create WellPlateSchema
GET
/well-plate-schema/items
List WellPlateSchema items
GET
/well-plate-schema/{well_plate_schema_id}
Get WellPlateSchema by ID
PATCH
/well-plate-schema/{well_plate_schema_id}
Update WellPlateSchema
GET
/well-plate-schema/{well_plate_schema_id}/field-definitions/items
List SchemaFieldDefinition items
POST
/well-plate-schema:batch-create
Batch create WellPlateSchema
PATCH
/well-plate-schema:batch-update
Batch update WellPlateSchema
POST
/well-plate-schema:bulk-create
Bulk create WellPlateSchema
PATCH
/well-plate-schema:bulk-update
Bulk update WellPlateSchema
WorkflowOutput 8
Represents the result or product of completing a WorkflowTask. Each output is associated with a single task. Outputs can contain schema-defined fields that capture structured data…
POST
/workflow-output
Create WorkflowOutput
GET
/workflow-output/items
List WorkflowOutput items
GET
/workflow-output/{workflow_output_id}
Get WorkflowOutput by ID
PATCH
/workflow-output/{workflow_output_id}
Update WorkflowOutput
POST
/workflow-output:batch-create
Batch create WorkflowOutput
PATCH
/workflow-output:batch-update
Batch update WorkflowOutput
POST
/workflow-output:bulk-create
Bulk create WorkflowOutput
PATCH
/workflow-output:bulk-update
Bulk update WorkflowOutput
WorkflowOutputSchema 3
Defines the structure of WorkflowOutput instances produced by tasks of a given WorkflowTaskSchema. Each output schema specifies fieldDefinitions for the data to be captured, an op…
GET
/workflow-output-schema/items
List WorkflowOutputSchema items
GET
/workflow-output-schema/{workflow_output_schema_id}
Get WorkflowOutputSchema by ID
GET
/workflow-output-schema/{workflow_output_schema_id}/field-definitions/items
List SchemaFieldDefinition items
WorkflowTask 10
Represents a unit of work within a WorkflowTaskGroup. Each task has a status that progresses through a configurable lifecycle (see WorkflowTaskStatusLifecycle), an optional assign…
POST
/workflow-task
Create WorkflowTask
GET
/workflow-task/items
List WorkflowTask items
GET
/workflow-task/{workflow_task_id}
Get WorkflowTask by ID
PATCH
/workflow-task/{workflow_task_id}
Update WorkflowTask
GET
/workflow-task/{workflow_task_id}/child-tasks/items
List WorkflowTask items
GET
/workflow-task/{workflow_task_id}/root-workflow-tasks/items
List WorkflowTask items
POST
/workflow-task:batch-create
Batch create WorkflowTask
PATCH
/workflow-task:batch-update
Batch update WorkflowTask
POST
/workflow-task:bulk-create
Bulk create WorkflowTask
PATCH
/workflow-task:bulk-update
Bulk update WorkflowTask
WorkflowTaskGroup 10
A container that groups related WorkflowTask instances together, representing a cohesive unit of work. Task groups are created from a WorkflowTaskSchema (via workflowTaskSchema).…
POST
/workflow-task-group
Create WorkflowTaskGroup
GET
/workflow-task-group/items
List WorkflowTaskGroup items
GET
/workflow-task-group/{workflow_task_group_id}
Get WorkflowTaskGroup by ID
PATCH
/workflow-task-group/{workflow_task_group_id}
Update WorkflowTaskGroup
GET
/workflow-task-group/{workflow_task_group_id}/authors/items
List Principal items
GET
/workflow-task-group/{workflow_task_group_id}/child-workflow-task-groups/items
List WorkflowTaskGroup items
POST
/workflow-task-group:batch-create
Batch create WorkflowTaskGroup
PATCH
/workflow-task-group:batch-update
Batch update WorkflowTaskGroup
POST
/workflow-task-group:bulk-create
Bulk create WorkflowTaskGroup
PATCH
/workflow-task-group:bulk-update
Bulk update WorkflowTaskGroup
WorkflowTaskSchema 3
A configuration template that defines the structure and behavior of WorkflowTask instances. Each schema specifies an executionType (direct, entry, or flowchart) and custom fieldDe…
GET
/workflow-task-schema/items
List WorkflowTaskSchema items
GET
/workflow-task-schema/{workflow_task_schema_id}
Get WorkflowTaskSchema by ID
GET
/workflow-task-schema/{workflow_task_schema_id}/field-definitions/items
List SchemaFieldDefinition items
Worklist 11
A typed collection of items used to group related objects for batch operations. Unlike folders, items can belong to multiple worklists simultaneously, making worklists useful as t…
POST
/worklist
Create Worklist
GET
/worklist/items
List Worklist items
DELETE
/worklist/{worklist_id}
Delete Worklist
GET
/worklist/{worklist_id}
Get Worklist by ID
PATCH
/worklist/{worklist_id}
Update Worklist
GET
/worklist/{worklist_id}/items/items
List Worklistable items
POST
/worklist:batch-create
Batch create Worklist
POST
/worklist:batch-delete
Batch delete Worklist
PATCH
/worklist:batch-update
Batch update Worklist
POST
/worklist:bulk-create
Bulk create Worklist
PATCH
/worklist:bulk-update
Bulk update Worklist
Worksheet 4
A structured document container used to organize and execute procedural work within Benchling's notebook system. Worksheets contain ordered WorksheetStepGroups, each holding Works…
GET
/worksheet/items
List Worksheet items
GET
/worksheet/{worksheet_id}
Get Worksheet by ID
GET
/worksheet/{worksheet_id}/applicable-review-processes/items
List ReviewProcess items
GET
/worksheet/{worksheet_id}/authors/items
List Principal items
Schemas 1167
The contract defines 1167 schemas that model the data the API accepts and returns. The most detailed are AuditLog (31 properties), ProteinSchema (25 properties), MixtureSchema (25 properties), IOligoDuplex (25 properties). Each schema is shown below with its type and property counts.
AaAnnotation
object
Represents an annotated region on an amino acid sequence (AaSequence). Annotations mark functional domains, binding sites, post-translational modifications, en…
9 properties
AaAnnotationInput
object
6 properties
3 required
AaAnnotationInputUpdate
object
7 properties
3 required
AaChainConfigurationInput
object
1 property
1 required
AaDomainConfigurationInput
object
1 property
1 required
AaPairConfigurationInput
object
1 property
1 required
AaPartLinkFieldDefinition
object
A schema field definition for linking to AA parts.
13 properties
AaSequence
AaSequenceLinkFieldDefinition
object
A schema field definition for linking to AA sequences.
14 properties
AaSequencePaginatedList
object
2 properties
AaSequenceRef
object
2 properties
AaSequenceSchema
object
Defines the structure, field definitions, and configuration options for AA sequences.
23 properties
AaSequenceSchemaPaginatedList
object
2 properties
AaSequenceSchemaRef
object
2 properties
AaSequenceSchemaSetFieldDefinitionsInput
object
1 property
1 required
AaSubElementConfigurationInput
object
1 property
1 required
AddColumnTransform
object
A data transform that adds a new column to the file with values resolved via a LookupConfig. Used in input file generation to enrich data with looked-up values.
3 properties
AddColumnTransformationProperties
object
Properties for an ADDCOLUMN transform, specifying the name of the new column to add.
2 properties
AlignedNucleotideSequence
object
Represents a single sequence row within a NucleotideAlignment. Each AlignedNucleotideSequence contains the aligned bases (including gap characters for insertio…
9 properties
AlignedNucleotideSequencePaginatedList
object
2 properties
AlignmentFileInput
object
3 properties
Analysis
object
13 properties
AnalysisPaginatedList
object
2 properties
AnalysisRef
object
2 properties
AnalysisTemplate
object
A reusable pipeline configuration that can be instantiated to create new Analysis objects. AnalysisTemplates define a complete data processing workflow with Pi…
18 properties
AnalysisTemplateDataFrameVariable
object
Defines a data frame placeholder within an AnalysisTemplate that users must provide when applying the template. Each variable specifies which PipelineStep inpu…
15 properties
AnalysisTemplateDataFrameVariablePaginatedList
object
2 properties
AnalysisTemplateDataFrameVariableUnpaginatedList
object
1 property
AnalysisTemplatePaginatedList
object
2 properties
AnalysisTemplateRef
object
2 properties
AnalysisTemplateVariable
object
Defines a configuration parameter within an AnalysisTemplate that users can customize when applying the template. Unlike AnalysisTemplateDataFrameVariable whic…
13 properties
AnalysisTemplateVariablePaginatedList
object
2 properties
AnalysisTemplateVariableUnpaginatedList
object
1 property
AntibodyLinkFieldDefinition
object
A schema field definition for linking to Antibodies.
13 properties
AntibodySchemaSetFieldDefinitionsInput
object
1 property
1 required
AntigenConfigurationInput
object
1 property
1 required
AnyEntityLinkFieldDefinition
object
A schema field definition for linking to any entity type.
12 properties
AnyType
AppCanvas
object
Represents a Benchling App canvas, an embedded UI surface that apps use to render custom interactive content within notebook entries, entry templates, assay ru…
13 properties
AppCanvasUiBlockInput
object
AppConfigDropdownOption
object
Defines an option within a dropdown-type app configuration field.
4 properties
AppConfigFieldDefinition
object
Defines a field within an app configuration that references schema fields. Specifies the field name, type, whether it accepts multiple values, and whether it i…
7 properties
AppConfigOption
object
Defines a configuration option in an app's configuration schema. Each option has a name, optional description, and a configSpec defining the expected value typ…
4 properties
AppConfigValue
object
Represents a configured value for a Benchling App on a specific tenant. Each config value has a path identifying its location in the configuration hierarchy an…
7 properties
AppConfigValuePaginatedList
object
2 properties
AppConfigValueUnpaginatedList
object
1 property
AppConfigWorkflowTaskSchemaOutput
object
Defines the output field structure for a workflow task schema configuration.
2 properties
AppHomepageFeatureSpec
object
Defines a homepage feature for a Benchling App, providing a dedicated landing page within the Benchling application for the app's functionality.
3 properties
AppInstallation
object
Represents an installed Benchling App on a tenant, created from an AppDefinitionVersion. App installations store tenant-specific configuration values and featu…
10 properties
AppInstallationPaginatedList
object
2 properties
AppMessageSubscription
object
Represents an app's subscription to a specific event type, specifying the event type and how notifications should be delivered (see DeliveryMethod).
3 properties
AppSession
object
Represents a running or completed session for a Benchling App. App sessions track long-running app operations, providing status updates and user-facing message…
9 properties
AppSessionMessage
object
A status message displayed to the user within an app session. Messages convey progress, warnings, results, or errors from a running Benchling App. Each message…
3 properties
AppSessionMessageInput
object
2 properties
1 required
AppSessionPaginatedList
object
2 properties
ArithmeticTransform
object
A data transform that performs arithmetic operations between two variables (columns or constants) and writes the result to a new column.
3 properties
ArithmeticTransformColumnVariable
object
A variable in an arithmetic transform that references values from a named column in the file.
3 properties
ArithmeticTransformConstantVariable
object
A variable in an arithmetic transform that holds a fixed numeric constant.
3 properties
ArithmeticTransformationProperties
object
Properties for an ARITHMETIC transform, defining the operator, operands, and the name of the result column. Supports addition, subtraction, multiplication, and…
5 properties
ArrayAppConfigOption
object
A config option nested within an array-type app configuration field. Structurally identical to AppConfigOption — it has a name and a configSpec — but its confi…
4 properties
ArrayAppConfigSpec
object
Specifies that an app configuration field should accept an array of values.
5 properties
ArrayElementAppConfigValue
object
Stores an element value within an array-type app configuration.
2 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
AssayRequestLinkFieldDefinition
object
A schema field definition for linking to assay requests.
12 properties
AssayResultLinkFieldDefinition
object
A schema field definition for linking to assay results.
13 properties
AssayRunFeatureSpec
object
Defines an assay run feature for a Benchling App, allowing the app to process or generate lab automation run data.
3 properties
AssayRunFeatureValue
object
Links an app's assay run feature to a specific resource (typically a run schema) on a tenant. The featureId identifies the feature from the app definition, and…
3 properties
AssayRunLinkFieldDefinition
object
A schema field definition for linking to assay runs.
13 properties
Assembly
object
Represents a molecular cloning assembly that combines multiple DNA fragments into complete constructs. Assemblies model the process of joining fragment sequenc…
9 properties
AssemblyPaginatedList
object
2 properties
AsyncTaskLink
object
2 properties
AttachmentContentInput
object
4 properties
2 required
AttachmentDocumentContent
object
Represents an external file attachment embedded in notebook or document content. Attachments expose file metadata, a temporary download URL, and indentation wi…
8 properties
AuditLog
object
Represents a single entry in an object's audit log. Each entry captures what changed, who made the change, and contextual information about the affected object…
31 properties
AuditLogExportInput
object
2 properties
2 required
AuditLogExportOutput
object
Output of the audit log export custom method. Contains a presigned download URL for the exported file.
1 property
AuditLogPaginatedList
object
2 properties
AutomationInputFileConfig
object
Defines the configuration for generating input files that drive laboratory automation instruments. An AutomationInputFileConfig specifies how to pull sample da…
12 properties
AutomationInputFileConfigUnpaginatedList
object
1 property
AutomationInputFileDestinationInfo
object
Describes a destination target for rows in a lab automation input file. Contains a lookup configuration for resolving destination samples and an optional displ…
2 properties
AutomationInputFileNamePart
object
Represents a single segment of a generated input file name. Parts are concatenated in order to build the file name and can contain static text, date/time stamp…
4 properties
AutomationInputFileRowConfig
object
Configures how a set of rows is generated for a lab automation input file. Each row config specifies a data source via LookupConfig, an optional destination, c…
4 properties
AutomationInputFileRowConfigColumn
object
Defines a single column within an input file row configuration. Each column has a lookup configuration that determines the values to populate and a display nam…
2 properties
AutomationOutputFileConfig
object
Defines the configuration for processing output files from laboratory automation instruments and converting them into Benchling data. An AutomationOutputFileCo…
18 properties
AutomationOutputFileConfigUnpaginatedList
object
1 property
AutomationOutputFileEntitySchemaInfo
object
Configuration for registering or updating entities when processing an automation output file. Specifies the entity schema, destination folder, naming strategy,…
7 properties
AutomationOutputFileInventorySchemaInfo
object
Configuration for creating or updating inventory items (plates, boxes, or containers) when processing an automation output file. Specifies the destination sche…
5 properties
AutomationOutputFileNamedColumnType
object
Associates a column name with its data type in an automation output file configuration. Used instead of plain column name strings when the column type must be…
3 properties
AutomationOutputFileResultSchemaInfo
object
Configuration for creating assay results when processing an automation output file. Specifies the result schema and field mappings that control how file data i…
3 properties
AutomationOutputFileTransformationFieldInfo
object
Maps a schema field to a data source when processing an automation output file. Specifies how to populate the field: directly from a file column, from the prim…
6 properties
AutomationTransformConfig
object
BarcodeInput
object
BaseCreateMessageBlockInput
object
BaseFieldDefinition
object
A basic schema field definition for primitive data types. Used for fields with types like TEXT, INTEGER, FLOAT, BOOLEAN, DATE, DATETIME, JSON, and LONGTEXT. Ea…
11 properties
BaseSystemCategoryConfiguration
object
Default configuration for system categories that require no additional configuration beyond the system category identifier.
2 properties
BenchlingItemContentInput
object
3 properties
2 required
BenchlingItemDocumentContent
object
Represents a Benchling item embedded in notebook or document content, identifying the referenced Benchling object.
3 properties
BlobLinkFieldDefinition
object
A schema field definition for linking to blobs (file attachments).
12 properties
BooleanAppConfigSpec
object
Specifies that an app configuration field should accept a boolean value.
2 properties
BooleanAppConfigValue
object
Stores a boolean value in an app configuration field.
2 properties
BooleanFieldDefinition
object
A boolean field definition for true/false values.
11 properties
BooleanValue
object
A type that represents boolean values.
2 properties
Box
BoxPaginatedList
object
2 properties
BoxSchema
object
Defines the structure and constraints for a category of Boxes in Benchling's inventory system. A BoxSchema specifies the grid dimensions (height and width) det…
16 properties
BoxSchemaPaginatedList
object
2 properties
BoxSchemaRef
object
2 properties
BulkImport
object
1 property
1 required
ButtonUiBlock
object
A button block that triggers an app interaction when clicked.
4 properties
ButtonUiBlockInput
object
4 properties
3 required
CanvasFeatureSpec
object
Defines a canvas feature for a Benchling App, which provides an embedded UI surface within entries or templates. Canvases allow apps to render custom interacti…
4 properties
ChainLinkedSchema
object
3 properties
ChainLinkedSchemaInput
object
2 properties
2 required
Chart
object
A Chart is a data visualization within Benchling. Charts can be created directly (for example, via APIs or the UI) or generated from other workflows. Charts st…
18 properties
ChartPaginatedList
object
2 properties
ChatSourceInput
object
CheckoutRecord
object
Tracks the checkout status of an inventory item such as a Container. When laboratory samples need to be temporarily removed from storage (e.g., for an experime…
5 properties
CheckoutRecordInput
object
3 properties
1 required
ChemSimplePolymer
object
Represents a small molecule within a complex polymer structure. Contains SMILES and molfile representations of the chemical structure, along with connections t…
7 properties
ChemicalStructureInput
object
2 properties
2 required
ChipUiBlock
object
A chip block that displays a short piece of information.
3 properties
ChipUiBlockInput
object
3 properties
3 required
ClustalOOptionsInput
object
5 properties
CodeBlockContentInput
object
2 properties
2 required
CodeBlockDocumentContent
object
Represents a block of code or preformatted text within notebook or document content. Code blocks preserve the text content for display as a standalone code blo…
2 properties
CollaboratableRef
object
2 properties
Collaboration
object
A Collaboration indicates that a Principal or Group is granted a Policy on a Resource. Some Collaborations represent Ownership, while others indicate that a Re…
9 properties
CollaborationPaginatedList
object
2 properties
CollaborationUnpaginatedList
object
1 property
CollaboratorReferenceInput
object
2 properties
1 required
ColumnMapping
object
3 properties
3 required
ComplexPolymerConnection
object
Represents a chemical bond between two polymers within a complex polymer structure. Connections can be covalent bonds (including disulfide bonds) or hydrogen b…
6 properties
ComplexPolymerResolvedAttachment
object
Detailed information about a group of contiguous connections in a complex polymer. The entire chemical structure of the connection group, and any components in…
3 properties
ComplexPolymerStructure
object
Contains the complete structural definition of a complex polymer, including all component polymers and their interconnections. This is the core data structure…
4 properties
ConcentrationLayerInput
object
4 properties
3 required
ConcentrationWellInput
object
2 properties
2 required
ConditionOrderForPmdvInput
object
2 properties
2 required
ConfigImportHistoryEntry
object
Records a configuration import operation from one Benchling tenant to another. Each entry captures the source tenant, target organization, who performed the im…
12 properties
ConfigImportHistoryEntryPaginatedList
object
2 properties
ConfirmationMethodByParamVersionId
object
Associates a procedure parameter version with its confirmation method, keyed by the parameter version ID. Used in ProcedureRunPlan to look up how a specific ve…
3 properties
ConfirmationMethodByParamVersionIdInput
object
2 properties
2 required
ConnectionSide
object
Represents one endpoint of a connection between polymers in a complex polymer structure. Identifies the specific attachment point including the polymer referen…
5 properties
ConnectorsInput
object
1 property
1 required
Constraint
object
Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see field…
3 properties
Container
ContainerContent
object
Represents a biological or chemical entity stored within a Container or well. Each ContainerContent links an Entity (such as a DNA sequence, protein, or custom…
5 properties
ContainerNameTemplate
object
A name template for containers.
2 properties
ContainerNameTemplateInput
object
1 property
1 required
ContainerNameTemplatePart
object
A part in a container name template.
3 properties
ContainerNameTemplatePartInput
object
2 properties
1 required
ContainerPaginatedList
object
2 properties
ContainerRef
object
2 properties
ContainerRemoveContentInput
object
1 property
1 required
ContainerSchema
object
Defines the structure and metadata for a category of Containers in Benchling's inventory system. A ContainerSchema specifies the container type (e.g., "1.5mL M…
13 properties
ContainerSchemaPaginatedList
object
2 properties
ContainerSchemaRef
object
2 properties
ContainerUnpaginatedList
object
1 property
ContainerUpdateContentConcentrationInput
object
2 properties
2 required
ContentItemInput
object
12 properties
3 required
CreateAASequenceSchemaConstraintInput
object
2 properties
CreateAaPartLinkFieldDefinitionInput
object
8 properties
6 required
CreateAaSequenceInput
object
12 properties
3 required
CreateAaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
CreateAaSequenceSchemaInput
object
16 properties
4 required
CreateAgentInput
object
6 properties
1 required
CreateAndUploadScratchFileInput
object
3 properties
CreateAntibodyLinkFieldDefinitionInput
object
8 properties
6 required
CreateAntibodySchemaInput
object
16 properties
6 required
CreateAnyEntityLinkFieldDefinitionInput
object
6 properties
5 required
CreateAppCanvasInput
object
7 properties
4 required
CreateAppSessionInput
object
4 properties
3 required
CreateAssayRequestLinkFieldDefinitionInput
object
7 properties
6 required
CreateAssayResultLinkFieldDefinitionInput
object
7 properties
6 required
CreateAssayRunLinkFieldDefinitionInput
object
7 properties
6 required
CreateBaseUnitInput
object
3 properties
3 required
CreateBlobLinkFieldDefinitionInput
object
6 properties
5 required
CreateBooleanFieldDefinitionInput
object
5 properties
4 required
CreateBoxInput
object
6 properties
1 required
CreateBoxSchemaInput
object
10 properties
5 required
CreateChartInput
object
9 properties
4 required
CreateCollaborationInput
object
4 properties
3 required
CreateComplexPolymerSchemaFieldSpecInput
object
2 properties
2 required
CreateConsensusAlignmentInput
object
7 properties
2 required
CreateContainerInput
object
9 properties
1 required
CreateContainerSchemaInput
object
7 properties
3 required
CreateCustomEntityInput
object
10 properties
3 required
CreateCustomEntityLinkFieldDefinitionInput
object
8 properties
6 required
CreateCustomEntitySchemaInput
object
15 properties
3 required
CreateDateFieldDefinitionInput
object
5 properties
4 required
CreateDateTimeFieldDefinitionInput
object
5 properties
4 required
CreateDnaOligoInput
object
15 properties
2 required
CreateDnaOligoLinkFieldDefinitionInput
object
8 properties
6 required
CreateDnaOligoSchemaInput
object
16 properties
4 required
CreateDnaPartLinkFieldDefinitionInput
object
8 properties
6 required
CreateDnaSequenceInput
object
16 properties
3 required
CreateDnaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
CreateDnaSequenceSchemaInput
object
16 properties
4 required
CreateDropdownInput
object
3 properties
3 required
CreateDropdownLinkFieldDefinitionInput
object
7 properties
6 required
CreateDropdownOptionInput
object
1 property
1 required
CreateEntitySchemaConstraintInput
object
1 property
CreateEntryContentInput
object
CreateEntryInput
object
6 properties
2 required
CreateEntryLinkFieldDefinitionInput
object
6 properties
5 required
CreateEquipmentLinkFieldDefinitionInput
object
8 properties
6 required
CreateEquipmentSchemaInput
object
15 properties
3 required
CreateFieldsetConstraintInput
object
3 properties
CreateFieldsetInput
object
9 properties
3 required
CreateFieldsetLinkFieldDefinitionInput
object
7 properties
6 required
CreateFileAttachmentInput
object
2 properties
2 required
CreateFileInput
object
3 properties
3 required
CreateFloatFieldDefinitionInput
object
9 properties
4 required
CreateFolderInput
object
3 properties
2 required
CreateFormulaUnitTermInput
object
2 properties
2 required
CreateIntegerFieldDefinitionInput
object
8 properties
4 required
CreateJsonFieldDefinitionInput
object
5 properties
4 required
CreateLibraryParameterDefinitionInput
object
5 properties
3 required
CreateLocationInput
object
5 properties
2 required
CreateLocationSchemaInput
object
7 properties
3 required
CreateLongTextFieldDefinitionInput
object
5 properties
4 required
CreateMatrixPlateInput
object
8 properties
1 required
CreateMatrixPlateSchemaInput
object
10 properties
5 required
CreateMixtureLinkFieldDefinitionInput
object
8 properties
6 required
CreateMixtureSchemaInput
object
18 properties
4 required
CreateMoleculeInput
object
11 properties
3 required
CreateMoleculeLinkFieldDefinitionInput
object
8 properties
6 required
CreateMoleculeSchemaConstraintInput
object
2 properties
CreateMoleculeSchemaInput
object
15 properties
3 required
CreateOligoConjugateLinkFieldDefinitionInput
object
8 properties
6 required
CreateOligoConjugateSchemaInput
object
17 properties
5 required
CreateOligoDuplexLinkFieldDefinitionInput
object
8 properties
6 required
CreateOligoDuplexSchemaInput
object
18 properties
6 required
CreatePlateDesignTemplateInput
object
3 properties
3 required
CreateProcedureRunPlanConditionInput
object
6 properties
6 required
CreateProcedureRunPlanInput
object
5 properties
5 required
CreateProjectInput
object
5 properties
2 required
CreateProteinFormatInput
object
2 properties
1 required
CreateProteinInput
object
13 properties
5 required
CreateRegistrationTableInput
object
2 properties
2 required
CreateRequestV2DefinitionInput
object
5 properties
4 required
CreateResultInput
object
4 properties
3 required
CreateResultTableInput
object
2 properties
2 required
CreateRnaOligoInput
object
15 properties
2 required
CreateRnaOligoLinkFieldDefinitionInput
object
8 properties
6 required
CreateRnaOligoSchemaInput
object
16 properties
4 required
CreateRnaSequenceInput
object
19 properties
2 required
CreateRnaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
CreateRnaSequenceSchemaInput
object
16 properties
4 required
CreateScratchFileInput
object
2 properties
1 required
CreateScratchPlateInput
object
14 properties
1 required
CreateSequenceSchemaConstraintInput
object
2 properties
CreateStorableLinkFieldDefinitionInput
object
7 properties
6 required
CreateStudyInput
object
10 properties
2 required
CreateStudyItemAssociationInput
object
2 properties
2 required
CreateStudySchemaInput
object
11 properties
4 required
CreateSystemCategoryLinkFieldDefinitionInput
object
7 properties
6 required
CreateTemplateAlignmentInput
object
7 properties
3 required
CreateTestDefinitionInput
object
4 properties
4 required
CreateTextFieldDefinitionInput
object
5 properties
4 required
CreateTextInput
object
2 properties
2 required
CreateTextMessageBlockInput
object
2 properties
2 required
CreateTranscriptionLinkFieldDefinitionInput
object
8 properties
6 required
CreateTranslationLinkFieldDefinitionInput
object
8 properties
6 required
CreateUnitInput
object
5 properties
5 required
CreateUnitTypeInput
object
6 properties
5 required
CreateUnitTypeTermInput
object
2 properties
2 required
CreateWarehouseCredentialCustomMethodInput
object
2 properties
CreateWarehouseCredentialOutput
object
Output of the create warehouse credential custom method. Contains the created credential and the one-time password that must be saved by the caller.
2 properties
CreateWellPlateInput
object
6 properties
1 required
CreateWellPlateSchemaInput
object
10 properties
6 required
CreateWorkflowOutputInput
object
2 properties
1 required
CreateWorkflowTaskGroupInput
object
4 properties
2 required
CreateWorkflowTaskInput
object
5 properties
1 required
CreateWorklistInput
object
3 properties
2 required
CustomEntity
CustomEntityCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.customEntity.created event.
CustomEntityCreatedWebhookV3
Message body of a v3.customEntity.created event.
CustomEntityLinkFieldDefinition
object
A schema field definition for linking to custom entities.
14 properties
CustomEntityPaginatedList
object
2 properties
CustomEntityRef
object
2 properties
CustomEntitySchema
object
22 properties
CustomEntitySchemaPaginatedList
object
2 properties
CustomEntitySchemaRef
object
2 properties
CustomEntitySchemaSetFieldDefinitionsInput
object
1 property
1 required
CustomEntityUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.customEntity.updated event.
CustomEntityUpdatedWebhookV3
Message body of a v3.customEntity.updated event.
CustomField
object
A name-value pair for storing additional metadata on objects that support custom fields. CustomFields provide a flexible way to attach arbitrary string data to…
3 properties
CustomFieldInput
object
2 properties
1 required
CustomTransform
object
A data transform that delegates processing to an external Benchling App. The app is identified by its API ID in the transformation properties.
3 properties
CustomTransformationProperties
object
Properties for a CUSTOM transform, identifying the Benchling App that performs the transformation via its API ID.
2 properties
CutSiteDetail
object
Describes the cleavage pattern of a restriction enzyme relative to its recognition site. The position field indicates where the 5' strand is cut, while offset…
3 properties
DataFrame
object
DataFrame stores non-schematized tabular data, with Benchling-aware column types (see DataFrameColumn). Data frames are not searchable and lack their own permi…
12 properties
DataFrameColumn
object
Defines a column within a DataFrame, including its internal system name, user-facing display name, and data type specification.
4 properties
DataFrameManifestItem
object
Represents one part of a DataFrame's downloadable row data. Currently, the manifest always contains exactly one item. The array structure is forward-compatible…
3 properties
DataFramePaginatedList
object
2 properties
DataFrameRef
object
2 properties
DataParameterValuePlan
object
A pre-filled value for a data parameter within a MethodParametersPlan. The parameterId references the ProcedureParameterVersion this value applies to. The valu…
3 properties
DataParameterValuePlanInput
object
2 properties
2 required
Dataset
object
Dataset stores non-schematized tabular data, with Benchling-aware column types. Datasets are first-class, searchable, archivable folder items. A Dataset's actu…
13 properties
DatasetPaginatedList
object
2 properties
DatasetRef
object
2 properties
DateAppConfigSpec
object
Specifies that an app configuration field should accept a date value.
2 properties
DateAppConfigValue
object
Stores a date value in an app configuration field.
2 properties
DateFieldDefinition
object
A date field definition for date-only values (without time).
11 properties
DateTimeAppConfigSpec
object
Specifies that an app configuration field should accept a datetime value.
2 properties
DateTimeAppConfigValue
object
Stores a datetime value in an app configuration field.
2 properties
DateTimeFieldDefinition
object
A datetime field definition for date and time values with timezone support.
11 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
DateValue
object
A type that represents date values.
2 properties
DecimalValue
object
A type that represents decimal value as strings.
3 properties
DeleteCollaborationInputWithPathParams
object
1 property
1 required
DeleteDocumentPartsInput
object
3 properties
3 required
DeleteFolderInputWithPathParams
object
1 property
1 required
DeleteNucleotideAlignmentInputWithPathParams
object
1 property
1 required
DeleteProcedureMethodExecutionInstanceAssociationInputWithPathParams
object
1 property
1 required
DeleteStudyItemAssociationInputWithPathParams
object
1 property
1 required
DeleteWorklistInputWithPathParams
object
1 property
1 required
DnaChainConfigurationInput
object
1 property
1 required
DnaDomainConfigurationInput
object
1 property
1 required
DnaOligo
DnaOligoCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.dnaOligo.created event.
DnaOligoCreatedWebhookV3
Message body of a v3.dnaOligo.created event.
DnaOligoLinkFieldDefinition
object
A schema field definition for linking to DNA Oligos.
14 properties
DnaOligoPaginatedList
object
2 properties
DnaOligoSchema
object
Defines the structure, field definitions, and configuration options for DNA oligos.
23 properties
DnaOligoSchemaPaginatedList
object
2 properties
DnaOligoSchemaRef
object
2 properties
DnaOligoSchemaSetFieldDefinitionsInput
object
1 property
1 required
DnaOligoUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.dnaOligo.updated event.
DnaOligoUpdatedWebhookV3
Message body of a v3.dnaOligo.updated event.
DnaPairConfigurationInput
object
1 property
1 required
DnaPart
object
Represents a region on a DNA sequence that matches or is derived from another registered DNA sequence. DnaPart features enable tracking the provenance of seque…
7 properties
DnaPartLinkFieldDefinition
object
A schema field definition for linking to DNA parts.
13 properties
DnaPartUnpaginatedList
object
1 property
DnaSequence
DnaSequenceCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.dnaSequence.created event.
DnaSequenceCreatedWebhookV3
Message body of a v3.dnaSequence.created event.
DnaSequenceLinkFieldDefinition
object
A schema field definition for linking to DNA sequences.
14 properties
DnaSequencePaginatedList
object
2 properties
DnaSequenceRef
object
2 properties
DnaSequenceSchema
object
Defines the structure, field definitions, and configuration options for DNA sequences.
23 properties
DnaSequenceSchemaPaginatedList
object
2 properties
DnaSequenceSchemaRef
object
2 properties
DnaSequenceSchemaSetFieldDefinitionsInput
object
1 property
1 required
DnaSequenceUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.dnaSequence.updated event.
DnaSequenceUpdatedWebhookV3
Message body of a v3.dnaSequence.updated event.
DnaSubElementConfigurationInput
object
1 property
1 required
DocumentContentInput
object
DocumentEmbeddable
object
DocumentLikeRef
object
2 properties
DocumentLikeVersionMetadata
object
Version metadata for a DocumentLike-style entry. Captures the API identifier of a particular version snapshot together with the time that version was produced.…
3 properties
DocumentPart
object
Represents an ordered piece of content within an entry, template, subtemplate, or document. Each document part wraps one content block and records its containe…
7 properties
DocumentPartPaginatedList
object
2 properties
DomainLinkedSchema
object
Links a specific domain type and specificity combination to an entity schema or interface. Used in protein schema configurations to specify which schema govern…
4 properties
DomainLinkedSchemaInput
object
2 properties
2 required
Dropdown
object
A configurable list of predefined values used for standardizing data entry in schema fields. Dropdowns provide controlled vocabulary choices that ensure consis…
7 properties
DropdownAppConfigSpec
object
Specifies that an app configuration field should be a dropdown with predefined options.
3 properties
DropdownLinkFieldDefinition
object
A schema field definition that links to a dropdown for value selection. The linkDefinition field references the Dropdown configuration that defines the availab…
13 properties
DropdownLinkFieldDefinitionPaginatedList
object
2 properties
DropdownMultiValueUiBlock
object
A multi-select dropdown block backed by a Benchling dropdown registry.
8 properties
DropdownMultiValueUiBlockInput
object
8 properties
3 required
DropdownOption
object
An individual selectable value within a Dropdown. Each DropdownOption represents one valid choice that users can select when populating a schema field configur…
5 properties
DropdownOptionPaginatedList
object
2 properties
DropdownOptionUnpaginatedList
object
1 property
DropdownPaginatedList
object
2 properties
DropdownRef
object
2 properties
DropdownUiBlock
object
A dropdown block backed by a Benchling dropdown registry.
8 properties
DropdownUiBlockInput
object
8 properties
3 required
DuplicateTransform
object
A data transform that copies an existing column to a new column with a different name.
3 properties
DuplicateTransformationProperties
object
Properties for a DUPLICATE transform, specifying the source column to copy and the name for the new duplicate column.
3 properties
EditingTargetInput
object
EntityAssociation
object
Every entity association maps a Benchling entity to one or more HELM references in the complex polymer. These HELM polymers each have the same chemical structu…
3 properties
EntityNameTemplate
object
A name template for entities.
3 properties
EntityNameTemplateInput
object
2 properties
2 required
EntityNameTemplatePart
object
A part in an entity name template.
3 properties
EntityNameTemplatePartInput
object
2 properties
1 required
EntityRef
object
2 properties
EntitySchema
object
Defines the structure and behavior for a category of registered entities in Benchling. EntitySchemas specify the field definitions (see fieldDefinitions and Sc…
15 properties
EntitySchemaAppConfigSpec
object
Specifies that an app configuration field should reference an entity schema. Kept separate from SchemaAppConfigSpec because it carries a subtype constraint.
4 properties
EntitySchemaAppConfigValue
object
Stores a reference to an entity schema in an app configuration field. Kept separate from ResourceAppConfigValue because it carries a subtype identifying the ki…
3 properties
EntitySchemaApplyFieldsetInput
object
2 properties
1 required
EntitySchemaApplyFieldsetOutput
object
Return shape for the applyfieldset API on entity schemas.
2 properties
EntitySchemaApplyFieldsetWarning
object
A warning raised when attempting to apply a fieldset to an entity schema.
4 properties
EntitySchemaBaseRef
object
2 properties
EntitySchemaPaginatedList
object
2 properties
EntitySchemaRef
object
2 properties
Entry
EntryContent
object
Represents a single content item within an EntrySection. The type field indicates what kind of content this is (see ContentType). This provides a simplified vi…
2 properties
EntryCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.entry.created event.
EntryCreatedWebhookV3
Message body of a v3.entry.created event.
EntryEditingTargetInput
object
2 properties
2 required
EntryLinkFieldDefinition
object
A schema field definition for linking to notebook entries.
12 properties
EntryPaginatedList
object
2 properties
EntryRef
object
2 properties
EntrySchema
object
Defines a schema that can be applied to Entries to add structured metadata through custom fields. Entry schemas allow organizations to standardize the informat…
14 properties
EntrySchemaPaginatedList
object
2 properties
EntrySchemaRef
object
2 properties
EntrySection
object
Represents a logical section within an Entry used to organize content into collapsible groups. While sections include a date field and were historically known…
5 properties
EntrySubtemplate
object
A reusable content block that can be inserted into DocumentLike objects. Subtemplates contain pre-defined note content (text, tables, etc.) that scientists com…
9 properties
EntrySubtemplatePaginatedList
object
2 properties
EntryTemplate
object
A template used to create new DocumentLike objects with pre-populated content and structure. EntryTemplates contain boilerplate text, tables, placeholders, and…
12 properties
EntryTemplatePaginatedList
object
2 properties
EntryTemplateRef
object
2 properties
EntryTemplateUnpaginatedList
object
1 property
Enzyme
object
Represents a restriction enzyme from Benchling's global catalog of commercially available enzymes. Restriction enzymes (also known as restriction endonucleases…
6 properties
EnzymeList
object
Represents a user-curated collection of restriction enzymes for molecular cloning workflows. EnzymeLists allow users and organizations to organize commonly use…
8 properties
EnzymeListPaginatedList
object
2 properties
EnzymePaginatedList
object
2 properties
EnzymeUnpaginatedList
object
1 property
EquipmentLinkFieldDefinition
object
A schema field definition for linking to Equipment.
14 properties
EquipmentSchema
object
Defines the structure, field definitions, and configuration options for Equipments.
22 properties
EquipmentSchemaPaginatedList
object
2 properties
EquipmentSchemaRef
object
2 properties
EquipmentSchemaSetFieldDefinitionsInput
object
1 property
1 required
EquipmentValuePlan
object
A pre-filled value for an equipment parameter within a MethodParametersPlan. The equipmentId references the ProcedureParameterVersion for the equipment paramet…
3 properties
EquipmentValuePlanInput
object
2 properties
2 required
EventSubscription
object
Configures delivery of Benchling events to external systems via AWS EventBridge. Event subscriptions enable real-time integration by streaming events (such as…
11 properties
EventSubscriptionPaginatedList
object
2 properties
ExperimentalRole
object
Represents the complete experimental designation of a well or container within an assay, combining a primary role (see PrimaryExperimentalRole), replicate grou…
4 properties
ExperimentalRoleInput
object
3 properties
3 required
ExpirationInfo
object
Provides expiration tracking for inventory items such as containers and their contents. The expirationDate may be explicitly set on the container or inherited…
3 properties
ExplicitBarcodeInput
object
2 properties
2 required
ExternalLinkedMolecule
object
Linked molecule from external registries/catalogs
9 properties
ExtraFootersTransform
object
A data transform that removes trailing footer rows from a file. Useful for instrument output files that append summary or metadata rows after the data.
3 properties
ExtraFootersTransformationProperties
object
Properties for an EXTRAFOOTERS transform, specifying how many trailing rows to remove from the bottom of the file.
2 properties
ExtraHeadersTransform
object
A data transform that handles files with extra header rows above the standard column header. Strips the specified header rows so downstream processing sees cle…
3 properties
ExtraHeadersTransformationProperties
object
Properties for an EXTRAHEADERS transform, specifying the row range that contains non-standard header rows to skip during file processing.
3 properties
FeatureLibrary
object
Represents a reusable collection of biological features for auto-annotating nucleotide and AA sequences. FeatureLibraries enable users to define common sequenc…
8 properties
FeatureLibraryItem
object
Represents a single feature definition within a FeatureLibrary used for auto-annotation. Each item defines a searchable pattern (nucleotide or amino acid seque…
10 properties
FeatureLibraryItemPaginatedList
object
2 properties
FeatureLibraryPaginatedList
object
2 properties
FeatureLibraryRef
object
2 properties
FieldNameTemplatePartConfiguration
object
Configuration for a schema field name template part.
2 properties
FieldNameTemplatePartConfigurationInput
object
1 property
1 required
FieldValueInput
object
1 property
1 required
Fieldset
object
A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. Fieldsets are created and manag…
16 properties
FieldsetLinkFieldDefinition
object
A schema field definition for linking to entities that implement a fieldset (custom schema interface).
14 properties
FieldsetPaginatedList
object
2 properties
FieldsetRef
object
2 properties
FieldsetSetFieldDefinitionsInput
object
1 property
1 required
FieldsetUnpaginatedList
object
1 property
File
object
A File represents an uploaded document or data file that is surfaced in Benchling's Data Catalog for discovery and organization. Files are primarily created th…
13 properties
FilePaginatedList
object
2 properties
FileRef
object
2 properties
FileUploadUiBlock
object
A file upload block that accepts one or more file attachments.
8 properties
FileUploadUiBlockInput
object
8 properties
2 required
FilterTransform
object
A data transform that removes rows from the file based on column value conditions. Supports null checks, string/number comparisons, and set membership filters.
3 properties
FindReplaceTransform
object
A data transform that substitutes values in the file by finding occurrences and replacing them. Replacement values can be specified inline or resolved via a Lo…
2 properties
FloatAppConfigSpec
object
Specifies that an app configuration field should accept a floating-point number.
3 properties
FloatAppConfigValue
object
Stores a floating-point number value in an app configuration field.
2 properties
FloatFieldDefinition
object
A float field definition for decimal number values. Supports numeric constraints (min/max), display precision, and units.
15 properties
Folder
object
A hierarchical container for organizing entities, notebook entries, and other items within a Project. Folders support nested structures through parent-child re…
11 properties
FolderPaginatedList
object
2 properties
FolderRef
object
2 properties
FolderUnpaginatedList
object
1 property
FormulaUnitTerm
object
A term in the original formula of a UnitType that references an actual Unit rather than a base dimension. This is used to define relationships between units ac…
3 properties
GeneralError
object
5 properties
5 required
Germline
object
A database of reference sequences used to characterize protein sequences via alignment.
3 properties
GermlinePaginatedList
object
2 properties
GridCoordinates
object
Read model representing a fillable position in a box or plate.
5 properties
Group
object
GroupCollaboratorInfo
object
Represents a Group that is the subject of a Collaboration, along with sub-group information. In Group Collaborations, the Resource may be shared with a sub-gro…
3 properties
GroupMembership
object
Indicates that a Principal is a member of Group. Role indicates that the Principal is a member of a subgroup, such as Admins of the Group. Teams are the canoni…
7 properties
GroupMembershipPaginatedList
object
2 properties
GroupMembershipUnpaginatedList
object
1 property
HeaderContentInput
object
7 properties
3 required
HeaderDocumentContent
object
Represents a heading block within notebook or document content. Headers store the heading level, rich text, and indentation used to organize document sections.
7 properties
IAaSequence
object
17 properties
IAppInstallationRef
object
2 properties
IBox
object
15 properties
IContainer
object
20 properties
ICustomEntity
object
15 properties
IDnaOligo
object
18 properties
IDnaSequence
object
23 properties
IEntry
object
18 properties
ILocation
object
16 properties
IMatrixPlate
object
15 properties
IMixture
object
19 properties
IMolecule
object
17 properties
IOligoConjugate
object
An oligo conjugate is a specific type of complex polymer that consists of a single short DNA/RNA strand with multiple attached molecules (aka conjugates).
23 properties
IOligoDuplex
object
An oligo duplex is a specific type of complex polymer that consists of two complementary DNA/RNA strands, with multiple attached molecules on either strand (ak…
25 properties
IPlate
object
16 properties
IProtein
object
22 properties
IResult
object
8 properties
IRnaOligo
object
18 properties
IRnaSequence
object
21 properties
IRun
object
11 properties
IWellPlate
object
11 properties
Ingredient
object
Represents a single component within a Mixture, specifying the substance and its amount. Each Ingredient references a componentEntity (the substance being adde…
11 properties
InsertCoordinates
object
1 property
InsertDocumentPartsInput
object
4 properties
4 required
IntegerAppConfigSpec
object
Specifies that an app configuration field should accept an integer value.
3 properties
IntegerAppConfigValue
object
Stores an integer value in an app configuration field.
2 properties
IntegerFieldDefinition
object
An integer field definition for whole number values. Supports numeric constraints (min/max) and units.
14 properties
IntegerValue
object
A type that represents integer values.
2 properties
InternalLinkedMolecule
object
Linked molecule from the Benchling registry (internal)
4 properties
InternalServerError
object
6 properties
5 required
JsonAppConfigSpec
object
Specifies that an app configuration field should accept a JSON value.
2 properties
JsonAppConfigValue
object
Stores a JSON value (as a string) in an app configuration field.
2 properties
JsonFieldDefinition
object
A JSON field definition for storing structured JSON data.
11 properties
JsonValue
object
A type that represents JSON values.
2 properties
LabelTemplate
object
A LabelTemplate defines the format for printing physical labels for inventory items, such as containers, plates, and boxes. Each template contains a template s…
7 properties
LabelTemplatePaginatedList
object
2 properties
LegacyAppInstallation
object
Represents a legacy (pre-App Store) Benchling App installation on a tenant. Legacy apps are configured directly with webhook URLs and configuration specs rathe…
17 properties
LegacyAppInstallationPaginatedList
object
2 properties
LibraryParameterDefinition
object
A reusable parameter definition stored in the Parameter Library. LibraryParameterDefinitions allow organizations to standardize parameters used across multiple…
13 properties
LibraryParameterDefinitionPaginatedList
object
2 properties
LinkSpan
object
LinkSpan is used when we want to apply a URL to a particular span of the text.
4 properties
LinkSpanInput
object
3 properties
ListItemContentInput
object
7 properties
3 required
ListItemDocumentContent
object
Represents a single list item within notebook or document content. List items store their marker style, rich text, and indentation for ordered, unordered, and…
7 properties
Location
LocationInput
object
LocationPaginatedList
object
2 properties
LocationRef
object
2 properties
LocationSchema
object
Defines the structure and metadata for a category of Locations in Benchling's inventory system. A LocationSchema specifies schema field definitions for capturi…
13 properties
LocationSchemaPaginatedList
object
2 properties
LocationSchemaRef
object
2 properties
LongTextFieldDefinition
object
A long text field definition for multi-line text values with no length restrictions.
11 properties
MafftOptionsInput
object
6 properties
MarkdownUiBlock
object
A block that renders Markdown content.
3 properties
MarkdownUiBlockInput
object
3 properties
3 required
MaterialInputValuePlan
object
A pre-filled value for a material input within a MethodParametersPlan. The materialInputId references the ProcedureParameterVersion for the material input this…
3 properties
MaterialInputValuePlanInput
object
2 properties
2 required
MatrixPlate
MatrixPlatePaginatedList
object
2 properties
MatrixPlatePosition
object
A well position within a MatrixPlate.
3 properties
MatrixPlatePositionInput
object
2 properties
1 required
MatrixPlateSchema
object
Defines the structure and constraints for a category of MatrixPlates in Benchling's inventory system. A MatrixPlateSchema specifies the grid dimensions (height…
15 properties
MatrixPlateSchemaPaginatedList
object
2 properties
MatrixPlateSchemaRef
object
2 properties
McpServerChatSourceInput
object
2 properties
2 required
Measurement
object
Represents a quantity with an associated unit of measurement within Benchling's inventory system. Measurements are used throughout inventory to track container…
3 properties
MeasurementInput
object
2 properties
2 required
MeltTransform
object
A data transform that unpivots wide-format data into long format by converting selected value columns into rows, each identified by a variable name.
3 properties
MeltTransformationProperties
object
Properties for a MELT transform, specifying identifier columns to keep fixed, value columns to unpivot, and optional names for the new variable and value colum…
5 properties
Mention
object
Represents an inline mention of another Benchling item within text content. Mentions allow users to reference entities (sequences, samples, entries, etc.) dire…
3 properties
MentionInput
object
2 properties
MergeTransform
object
A data transform that concatenates values from multiple columns into a single output column, separated by a configurable delimiter.
3 properties
MergeTransformationProperties
object
Properties for a MERGE transform, specifying the columns to combine, the output column name, and the delimiter placed between merged values.
4 properties
MetadataColumnInput
object
5 properties
2 required
MetadataWellInput
object
2 properties
2 required
MethodParametersPlan
object
Contains the planned parameter values for a single unit operation (method) within a ProcedureRunPlanCondition. Links to a ProcedureMethodDefinitionVersion via…
4 properties
MethodParametersPlanInput
object
3 properties
3 required
Mixture
MixtureLinkFieldDefinition
object
A schema field definition for linking to mixtures.
14 properties
MixturePaginatedList
object
2 properties
MixtureSchema
object
Defines the structure, field definitions, and configuration options for Mixtures.
25 properties
MixtureSchemaPaginatedList
object
2 properties
MixtureSchemaRef
object
2 properties
MixtureSchemaSetFieldDefinitionsInput
object
1 property
1 required
ModifiedNucleotide
object
Represents a chemically modified nucleotide at a specific position in an oligonucleotide sequence. Each modification specifies the sugar, base, and phosphate m…
8 properties
ModifiedNucleotidePaginatedList
object
2 properties
Molecule
MoleculeLinkFieldDefinition
object
A schema field definition for linking to molecules.
14 properties
MoleculePaginatedList
object
2 properties
MoleculeRef
object
2 properties
MoleculeSchema
object
Defines the structure, field definitions, and configuration options for Molecule schemas.
22 properties
MoleculeSchemaPaginatedList
object
2 properties
MoleculeSchemaRef
object
2 properties
MoleculeSchemaSetFieldDefinitionsInput
object
1 property
1 required
MoveDocumentPartsInput
object
4 properties
4 required
MoveFolderInput
object
1 property
1 required
MultipleValuesFilterTransformationProperties
object
Properties for a FILTER transform that filters rows by checking whether a column's value is in (ISIN) or not in (NOTIN) a set of allowed values.
4 properties
NewSequenceInput
object
1 property
1 required
NucleotideAlignment
object
Represents a multiple sequence alignment of nucleotide sequences (DNA or RNA). Nucleotide alignments are used to compare sequence reads against a reference tem…
8 properties
NucleotideAlignmentPaginatedList
object
2 properties
NucleotideAlignmentRef
object
2 properties
NucleotideAnnotation
object
Represents a biological feature annotation on a nucleotide sequence (DNA or RNA). Annotations mark regions of interest such as genes, promoters, terminators, r…
8 properties
NucleotideAnnotationInput
object
8 properties
3 required
NucleotideMonomer
object
A building block component of modified oligonucleotides, representing a sugar, phosphate, or base subunit. Monomers are the chemical units that assemble to for…
19 properties
NucleotideMonomerPaginatedList
object
2 properties
NucleotideMonomerRef
object
2 properties
NucleotidePartInput
object
4 properties
3 required
NucleotideSequenceRef
object
2 properties
NucleotideSimplePolymer
object
Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues, any chemical modifications (see ModifiedNucle…
8 properties
NullFilterTransformationProperties
object
Properties for a FILTER transform that filters rows based on null or non-null values in a specified column.
3 properties
NumberValueFilterTransformationProperties
object
Properties for a FILTER transform that filters rows by comparing a column's numeric value using relational operators (EQ, NE, LE, LT, GE, GT).
4 properties
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
ObjectRef
object
2 properties
OligoAnnotationInput
object
8 properties
4 required
OligoConjugate
OligoConjugateCreate
object
12 properties
5 required
OligoConjugateLinkFieldDefinition
object
A schema field definition for linking to Oligo Conjugates.
14 properties
OligoConjugatePaginatedList
object
2 properties
OligoConjugateSchema
object
Defines the structure, field definitions, and configuration options for Oligo Conjugates.
22 properties
OligoConjugateSchemaPaginatedList
object
2 properties
OligoConjugateSchemaRef
object
2 properties
OligoConjugateSchemaSetFieldDefinitionsInput
object
1 property
1 required
OligoConjugateUpdate
object
12 properties
OligoConjugateUpdateWithPathParams
object
13 properties
1 required
OligoDuplex
OligoDuplexCreate
object
13 properties
6 required
OligoDuplexLinkFieldDefinition
object
A schema field definition for linking to Oligo Duplexes.
14 properties
OligoDuplexPaginatedList
object
2 properties
OligoDuplexSchema
object
Defines the structure, field definitions, and configuration options for Oligo Duplexes.
22 properties
OligoDuplexSchemaPaginatedList
object
2 properties
OligoDuplexSchemaRef
object
2 properties
OligoDuplexSchemaSetFieldDefinitionsInput
object
1 property
1 required
OligoDuplexUpdate
object
13 properties
OligoDuplexUpdateWithPathParams
object
14 properties
1 required
OligoRef
object
2 properties
Organization
object
Represents a group of users within Benchling, typically corresponding to a company, department, or research group. Organizations provide a many-to-many relatio…
7 properties
OrganizationPaginatedList
object
2 properties
OrganizationRef
object
2 properties
OwnerRef
object
2 properties
ParameterLayerInput
object
4 properties
3 required
ParameterWellInput
object
2 properties
2 required
PeptideSimplePolymer
object
Represents a peptide or protein chain within a complex polymer structure. Contains the amino acid residue sequence and connections to other polymers. The entit…
6 properties
PipelineRef
object
2 properties
PipelineStep
object
Represents a single operation node within a Pipeline's directed acyclic graph (DAG). Each step performs a specific transformation determined by its stepType (s…
12 properties
PipelineStepData
object
Represents actual data attached to an input or output slot of a PipelineStep during execution. Each PipelineStepData corresponds to a defined data shape (input…
7 properties
PipelineStepDataPaginatedList
object
2 properties
PipelineStepDataRef
object
2 properties
PipelineStepDataUnpaginatedList
object
1 property
PipelineStepPaginatedList
object
2 properties
PipelineStepRef
object
2 properties
PipelineStepUnpaginatedList
object
1 property
PivotTransform
object
A data transform that reshapes long-format data into wide format by pivoting unique values from a keys column into separate columns.
3 properties
PivotTransformationProperties
object
Properties for a PIVOT transform, specifying the index columns to group by, the keys column whose values become new column headers, and the values column to sp…
4 properties
Plate
PlateDesignTemplate
object
A named plate design template backed by a scratch plate that lives in a template collection. Plate design templates allow scratch plates to be organized and re…
13 properties
PlateDesignTemplatePaginatedList
object
2 properties
PlateLayout
object
Specifies the well-mapping layout used when generating input file rows for plate-based transfers. The layout type controls how sample positions on a source pla…
2 properties
PlatePaginatedList
object
2 properties
PlateSchema
object
Defines the structure and constraints for a category of Plates in Benchling's inventory system. A PlateSchema specifies the grid dimensions (height and width),…
15 properties
PlateSchemaPaginatedList
object
2 properties
PlateSchemaRef
object
2 properties
PlateShapeTransform
object
A data transform that extracts plate-shaped data from a file by locating the well grid at specified coordinates and optionally removing all surrounding cells.
3 properties
PlateShapeTransformationProperties
object
Properties for a PLATESHAPE transform, specifying the plate schema for expected dimensions, the cell coordinates of well A1, and whether to discard data outsid…
5 properties
Policy
object
Defines a named set of permissions that can be assigned to users or groups through collaborations. Policies contain PolicyStatements that specify allowed actio…
8 properties
PolicyPaginatedList
object
2 properties
PolicyRef
object
2 properties
PolicyStatement
object
A single permission rule within a Policy. Combines an ItemType (what kind of object), an Action (what operation), and a Condition (when it applies) to define a…
4 properties
PredictionBatch
object
Represents an execution of a Model Hub model against multiple data inputs (resulting in multiple Predictions). A PredictionBatch tracks the input configuration…
16 properties
PredictionBatchInput
object
6 properties
4 required
PredictionBatchJobConfigInput
object
2 properties
1 required
PredictionBatchPaginatedList
object
2 properties
PredictionBatchRef
object
2 properties
PredictionJob
object
Represents a single prediction within a PredictionBatch. Each PredictionJob captures the input configuration for one prediction and its association with input…
10 properties
PredictionJobPaginatedList
object
2 properties
Primer
object
Represents a primer binding site on a nucleotide sequence, indicating where an oligonucleotide primer anneals for PCR amplification or sequencing. The Primer l…
7 properties
PrimerBindPositionInput
object
3 properties
3 required
PrimerInput
object
3 properties
3 required
PrimerStartEndInput
object
3 properties
3 required
Principal
object
PrincipalCollaboratorInfo
object
Represents a Principal that is the subject for a Collaboration.
2 properties
PrincipalRef
object
2 properties
PrincipalUnpaginatedList
object
1 property
Printer
object
A Printer represents a network-connected label printer configured in Benchling for printing barcode labels on inventory items. Printers are associated with a R…
9 properties
PrinterPaginatedList
object
2 properties
Procedure
object
A reusable template that defines a structured experimental workflow. Procedures specify a sequence of method steps (see ProcedureMethodDefinitionVersion) conne…
16 properties
ProcedureDataParameterSetting
object
Configures a data parameter within a method, linking a parameter definition (ProcedureParameterVersion) with its planned values. Data parameters capture experi…
3 properties
ProcedureEdge
object
A directed connection between two nodes in a procedure flowchart. The edge's type (see ProcedureEdgeType) determines what sourceId and targetId reference: for…
4 properties
ProcedureEquipmentSetting
object
Configures equipment usage within a method, linking a parameter definition (ProcedureParameterVersion) with its planned values. Equipment settings specify inst…
3 properties
ProcedureExecutionStepGroup
object
Groups step execution instances by their execution phase during a procedure run. Analogous to ProcedureStepGroup but contains actual execution instances (Proce…
3 properties
ProcedureFlowchart
object
Contains the flowchart configuration for a Procedure or TemplateCollection. A ProcedureFlowchart acts as a container for flowchart versions (see ProcedureFlowc…
9 properties
ProcedureFlowchartConfigVersionProxy
object
Represents a snapshot of a procedure's flowchart configuration at a specific point in time. The flowchart defines the structure of a procedure as a directed gr…
6 properties
ProcedureFlowchartConfigVersionProxyPaginatedList
object
2 properties
ProcedureFlowchartConfigVersionProxyRef
object
2 properties
ProcedureFlowchartPaginatedList
object
2 properties
ProcedureFlowchartParentRef
object
2 properties
ProcedureFlowchartRef
object
2 properties
ProcedureFlowchartVersion
object
An immutable snapshot of a procedure's flowchart structure at a specific point in time. Each version contains the complete graph of method steps (see nodes and…
7 properties
ProcedureFlowchartVersionPaginatedList
object
2 properties
ProcedureFlowchartVersionRef
object
2 properties
ProcedureMaterialInputSetting
object
Configures a material input within a method, linking a parameter definition (ProcedureParameterVersion) with its planned values. Material inputs specify reagen…
3 properties
ProcedureMaterialOutputSetting
object
Configures a material output within a method, linking to a parameter definition (ProcedureParameterVersion). Material outputs specify products or intermediates…
2 properties
ProcedureMethodDefinitionVersion
object
A versioned method within a procedure flowchart. Methods are the building blocks of procedures, representing discrete experimental operations that scientists p…
11 properties
ProcedureMethodDefinitionVersionPaginatedList
object
2 properties
ProcedureMethodDefinitionVersionRef
object
2 properties
ProcedureMethodDefinitionVersionUnpaginatedList
object
1 property
ProcedureMethodExecutionInstance
object
An instance of a method being executed within a procedure run. When a scientist runs a procedure, each method in the flowchart becomes a ProcedureMethodExecuti…
19 properties
ProcedureMethodExecutionInstanceAssociation
object
Links two method execution instances across procedure runs to represent an intended connection within a study. This allows scientists to coordinate their analy…
8 properties
ProcedureMethodExecutionInstanceAssociationPaginatedList
object
2 properties
ProcedureMethodExecutionInstanceAssociationUpsert
object
2 properties
2 required
ProcedureMethodExecutionInstancePaginatedList
object
2 properties
ProcedureMethodExecutionInstanceRef
object
2 properties
ProcedureMethodExecutionInstanceUnpaginatedList
object
1 property
ProcedurePaginatedList
object
2 properties
ProcedureParameter
object
Represents a parameter entity within a procedure template. Parameters define the data, materials, or equipment that scientists interact with during procedure e…
6 properties
ProcedureParameterConfirmationValue
object
Records a scientist's confirmation of a parameter value during procedure execution. When running a procedure, scientists confirm that inputs (such as materials…
13 properties
ProcedureParameterConfirmationValuePaginatedList
object
2 properties
ProcedureParameterConfirmationValueUnpaginatedList
object
1 property
ProcedureParameterDataType
object
Specifies the value type configuration for a procedure parameter. Used within ProcedureParameterVersion to define what kind of data a parameter accepts. The ty…
5 properties
ProcedureParameterMeasuredValue
object
Records the actual measured or observed value for a parameter during procedure execution. Scientists enter measured values after performing an experimental ste…
12 properties
ProcedureParameterMeasuredValuePaginatedList
object
2 properties
ProcedureParameterMeasuredValueUnpaginatedList
object
1 property
ProcedureParameterPaginatedList
object
2 properties
ProcedureParameterPlannedValue
object
Stores the expected or planned value for a parameter, set during procedure setup or run planning. Used to specify anticipated inputs before execution begins—fo…
11 properties
ProcedureParameterPlannedValuePaginatedList
object
2 properties
ProcedureParameterPlannedValueRef
object
2 properties
ProcedureParameterPlannedValueUnpaginatedList
object
1 property
ProcedureParameterRef
object
2 properties
ProcedureParameterValueLinkedPlateWell
object
Associates a parameter value with a specific well on a laboratory plate. Used within ProcedureParameterPlannedValue, ProcedureParameterConfirmationValue, and P…
3 properties
ProcedureParameterVersion
object
A versioned definition of a procedure parameter. Each version specifies the parameter's name, description, data type configuration (dataType), and how values a…
13 properties
ProcedureParameterVersionPaginatedList
object
2 properties
ProcedureParameterVersionRef
object
2 properties
ProcedureRef
object
2 properties
ProcedureRun
object
An active execution of a procedure template. Created when scientists start running an experiment based on a Procedure. Contains experimental conditions (condit…
14 properties
ProcedureRunCondition
object
A ProcedureRunCondition represents a configuration of the methods of a Procedure that is being executed within a ProcedureRun. The values associated with the P…
8 properties
ProcedureRunConditionPaginatedList
object
2 properties
ProcedureRunConditionRef
object
2 properties
ProcedureRunConditionReplicate
object
A replicate of a ProcedureRunCondition, representing one execution of a condition's configuration. Scientists often run the same experimental condition multipl…
8 properties
ProcedureRunConditionReplicatePaginatedList
object
2 properties
ProcedureRunConditionReplicateRef
object
2 properties
ProcedureRunConditionReplicateUnpaginatedList
object
1 property
ProcedureRunConditionUnpaginatedList
object
1 property
ProcedureRunPaginatedList
object
2 properties
ProcedureRunPlan
object
A draft experiment plan that can be promoted to a ProcedureRun for execution. Scientists use run plans to configure experimental conditions, parameter values,…
13 properties
ProcedureRunPlanCondition
object
A planned experimental condition within a ProcedureRunPlan, representing how a procedure's methods will be configured when the plan is promoted to an actual Pr…
11 properties
ProcedureRunPlanConditionPaginatedList
object
2 properties
ProcedureRunPlanConditionReplicate
object
Represents a planned replicate within a ProcedureRunPlanCondition. Scientists often run the same experimental condition multiple times to obtain statistically…
3 properties
ProcedureRunPlanConditionReplicateInput
object
2 properties
1 required
ProcedureRunPlanConditionUnpaginatedList
object
1 property
ProcedureRunPlanPaginatedList
object
2 properties
ProcedureRunPlanRef
object
2 properties
ProcedureRunRef
object
2 properties
ProcedureStepDefinitionVersion
object
A versioned definition of a procedure step within a procedure flowchart. Steps represent documentation or instructions that guide scientists through a procedur…
4 properties
ProcedureStepDefinitionVersionPaginatedList
object
2 properties
ProcedureStepDefinitionVersionRef
object
2 properties
ProcedureStepExecutionInstance
object
An execution instance of a procedure step within a ProcedureMethodExecutionInstance. Created when a procedure run is started, representing a step where scienti…
9 properties
ProcedureStepExecutionInstancePaginatedList
object
2 properties
ProcedureStepExecutionInstanceRef
object
2 properties
ProcedureStepGroup
object
Groups procedure steps by their execution phase within a method. Each method contains multiple step groups (see ProcedureStepGroupType), and each group contain…
3 properties
ProductComponent
object
Reaction component sub-type for products
16 properties
Project
object
A top-level organizational container in Benchling that groups related work and controls access permissions. Projects contain Folders (see Folder) which in turn…
15 properties
ProjectCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.project.created event.
ProjectCreatedWebhookV3
Message body of a v3.project.created event.
ProjectPaginatedList
object
2 properties
ProjectRef
object
2 properties
ProjectUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.project.updated event.
ProjectUpdatedWebhookV3
Message body of a v3.project.updated event.
PromoteProcedureRunPlanInput
object
1 property
1 required
PromoteProcedureRunPlanOutput
object
Output returned when promoting procedure run plans to active procedure runs.
1 property
PromotedProcedureRunItem
object
A single procedure run created by promoting a procedure run plan.
3 properties
Protein
ProteinChain
object
Represents a polypeptide chain within an Protein, containing the domain composition. Each chain has a computed label derived from the format.
6 properties
ProteinChainInput
object
2 properties
2 required
ProteinChainNameTemplatePartConfiguration
object
Configuration for a protein chain name template part.
2 properties
ProteinChainNameTemplatePartConfigurationInput
object
1 property
1 required
ProteinDomain
object
Represents a domain within an Protein, containing the actual amino acid sequence for a specific label. Unlike ProteinFormatDomain which is a template, ProteinD…
5 properties
ProteinDomainInput
object
2 properties
2 required
ProteinDomainNameTemplatePartConfiguration
object
Configuration for a protein domain name template part.
2 properties
ProteinDomainNameTemplatePartConfigurationInput
object
1 property
1 required
ProteinFormat
object
A ProteinFormat defines the structural template for a class of proteins, specifying the arrangement of chains and domains. Formats can be built-in (e.g., IgG1,…
13 properties
ProteinFormatChain
object
A chain in a protein format, representing the slot where a polypeptide chain can be used in an entity of this format. Chains are uniquely identified by their l…
5 properties
ProteinFormatChainPosition
object
Defines each instance of a polypeptide chain within a ProteinFormat, specifying the chain type and its constituent domains. Each chain position has a unique re…
4 properties
ProteinFormatDomain
object
A domain in a protein format, representing the slot where an amino acid sequence can be used in an entity of this format. Domains are uniquely identified by th…
5 properties
ProteinFormatDomainPosition
object
Defines a domain position within a1 ProteinFormat, specifying the domain type and identity of each physical domain in the protein format. Each domain position…
4 properties
ProteinFormatPaginatedList
object
2 properties
ProteinFormatRef
object
2 properties
ProteinPaginatedList
object
2 properties
ProteinSchema
object
Defines the structure, field definitions, and configuration options for Proteins.
25 properties
ProteinSchemaPaginatedList
object
2 properties
ProteinVersion
object
A historical snapshot of an Protein at a specific point in time, preserving the complete structural state including domains, chains, and HELM notation. Protein…
11 properties
ProteinVersionPaginatedList
object
2 properties
ProteinVersionRef
object
2 properties
ProteinVersionUnpaginatedList
object
1 property
PublicDataChatSourceInput
object
1 property
1 required
PutScratchPlateInInventoryInput
object
8 properties
1 required
QuantityInput
object
2 properties
1 required
RangeCoordinates
object
2 properties
2 required
ReactantComponent
object
Reaction component sub-type for reactants
16 properties
Reaction
object
A Chemical Reaction is a process where molecules are transformed into new molecules.
15 properties
ReactionPaginatedList
object
2 properties
RegionsListItem
object
Represents a contiguous position range within a Translation or other multi-region feature. For spliced genes or complex reading frames, a Translation may span…
3 properties
RegistrationOrigin
object
Captures the provenance of an entity's registration into the registry. The originEntry links to the DocumentLike (typically an entry or notebook) from which th…
3 properties
Registry
object
A centralized, validated repository for entities and inventory items within an organization. The registry serves as the source of truth for registered items—en…
5 properties
RegistryPaginatedList
object
2 properties
RegistryRef
object
2 properties
RemoveQuotesTransform
object
A data transform that strips quote characters from all values in the file. Takes no additional configuration parameters.
3 properties
RequestV2Definition
object
A reusable template that defines the structure and configuration for requests in Benchling. Also known as a "Request Template" in the UI. Each RequestV2Definit…
16 properties
RequestV2DefinitionPaginatedList
object
2 properties
RequestV2DefinitionRef
object
2 properties
RequestV2Submission
object
A workflow request submitted from a RequestV2Definition (known as "Request Template" in the UI). When a request is submitted (status transitions to SENT), a Wo…
17 properties
RequestV2SubmissionPaginatedList
object
2 properties
RequestV2SubmissionRef
object
2 properties
ResourceAppConfigSpec
object
Specifies that an app configuration field should reference a Benchling object instance. The type field identifies the kind of object required, matching the Ben…
3 properties
ResourceAppConfigValue
object
Stores a reference to any Benchling object or schema that is identified by a resource ID. The type field identifies what kind of resource is referenced, matchi…
3 properties
Result
ResultPaginatedList
object
2 properties
ResultRef
object
2 properties
ResultSchema
object
Defines the structure and metadata fields for a category of assay Results in Benchling's lab automation system. A ResultSchema specifies the field definitions…
9 properties
ResultSchemaPaginatedList
object
2 properties
ResultSchemaRef
object
2 properties
Review
object
Represents an active or completed review of a reviewable item such as an Entry or StageEntry. A Review tracks the overall status, the assigned reviewers (see R…
9 properties
ReviewChange
object
Represents a single action taken within a review. ReviewChanges form an ordered history of all changes made to a review, including status transitions, reviewer…
8 properties
ReviewChangePaginatedList
object
2 properties
ReviewPaginatedList
object
2 properties
ReviewProcess
object
Defines a review process configuration that specifies how entries and other reviewable items should be reviewed. A ReviewProcess belongs to an Organization and…
8 properties
ReviewProcessPaginatedList
object
2 properties
ReviewProcessRef
object
2 properties
ReviewProcessStage
object
A single stage within a ReviewProcess that defines a required step in the review workflow. Each stage specifies what action reviewers must take (see ReviewProc…
12 properties
ReviewProcessStagePaginatedList
object
2 properties
ReviewProcessStageRef
object
2 properties
ReviewProcessUnpaginatedList
object
1 property
ReviewProcessVersion
object
A specific version of a ReviewProcess configuration. Review processes are versioned to allow changes to review requirements while preserving the rules that app…
4 properties
ReviewRef
object
2 properties
ReviewSnapshot
object
A point-in-time snapshot of a reviewable item (e.g. an Entry) captured when a review action was taken. Snapshots are a configurable feature enabled via ENABLEE…
4 properties
Reviewer
object
Represents a user assigned to review a specific stage of an Entry's review process. Each Reviewer is associated with a Review and tracks whether they have comp…
4 properties
RnaAnnotationInput
object
8 properties
3 required
RnaOligo
RnaOligoCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.rnaOligo.created event.
RnaOligoCreatedWebhookV3
Message body of a v3.rnaOligo.created event.
RnaOligoLinkFieldDefinition
object
A schema field definition for linking to RNA Oligos.
14 properties
RnaOligoPaginatedList
object
2 properties
RnaOligoSchema
object
Defines the structure, field definitions, and configuration options for RNA oligos.
23 properties
RnaOligoSchemaPaginatedList
object
2 properties
RnaOligoSchemaRef
object
2 properties
RnaOligoSchemaSetFieldDefinitionsInput
object
1 property
1 required
RnaOligoUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.rnaOligo.updated event.
RnaOligoUpdatedWebhookV3
Message body of a v3.rnaOligo.updated event.
RnaPart
object
Represents a region on an RNA sequence that matches or is derived from another registered RNA sequence. RnaPart features enable tracking the provenance of sequ…
7 properties
RnaPartInput
object
3 properties
3 required
RnaPartUnpaginatedList
object
1 property
RnaSequence
RnaSequenceCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.rnaSequence.created event.
RnaSequenceCreatedWebhookV3
Message body of a v3.rnaSequence.created event.
RnaSequenceLinkFieldDefinition
object
A schema field definition for linking to RNA sequences.
14 properties
RnaSequencePaginatedList
object
2 properties
RnaSequenceRef
object
2 properties
RnaSequenceSchema
object
Defines the structure, field definitions, and configuration options for RNA sequences
23 properties
RnaSequenceSchemaPaginatedList
object
2 properties
RnaSequenceSchemaRef
object
2 properties
RnaSequenceSchemaSetFieldDefinitionsInput
object
1 property
1 required
RnaSequenceUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.rnaSequence.updated event.
RnaSequenceUpdatedWebhookV3
Message body of a v3.rnaSequence.updated event.
RnaTranslationInput
object
7 properties
1 required
Run
RunCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.run.created event.
RunCreatedWebhookV3
Message body of a v3.run.created event.
RunDocumentContent
object
Represents a run embedded in notebook or document content. Run content connects a document part to its run schema and, when available, the specific run.
4 properties
RunPaginatedList
object
2 properties
RunRef
object
2 properties
RunSchema
object
Defines the structure and automation configuration for a category of Runs in Benchling's lab automation system. A RunSchema specifies field definitions for run…
15 properties
RunSchemaPaginatedList
object
2 properties
RunSchemaRef
object
2 properties
SchemaAppConfigSpec
object
Specifies that an app configuration field should reference one of the schema types that share a common structure: containerschema, plateschema, locationschema,…
4 properties
SchemaFieldDefinition
object
SchemaFieldDefinitionRef
object
2 properties
SchemaFieldDefinitionUnpaginatedList
object
1 property
SchemaFieldValue
object
Represents a field value on a schematized object, pairing a fieldDefinition (describing the field's type and constraints) with its actual value (a BenchlingVal…
5 properties
SchemaLinkFieldDefinition
object
A schema field definition for link types that reference other Benchling objects. Extends basic field properties with link-specific constraints.
12 properties
SchemaSetFieldDefinitionsOutput
object
Return shape for the setfielddefinitions API on schemas.
2 properties
ScratchFile
object
A ScratchFile represents raw file content used as intermediate input or output of pipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surf…
16 properties
ScratchFilePaginatedList
object
2 properties
ScratchFileRef
object
2 properties
ScratchPlate
object
A plate design or record used for designing, tracking, and analyzing experimental plates outside of the inventory. Scratch plates are the working surface for p…
9 properties
ScratchPlateLayer
object
A named layer within a ScratchPlate, each backed by its own DataFrame.
3 properties
ScratchPlateMeasurementInput
object
9 properties
2 required
ScratchPlatePaginatedList
object
2 properties
ScratchPlatePlateReaderAsmInput
object
1 property
1 required
ScratchPlateRef
object
2 properties
ScratchPlateTransferInput
object
6 properties
ScratchPlateTransferRequestInput
object
6 properties
4 required
ScratchPlateVendorFileInput
object
2 properties
2 required
ScratchPlateWellInput
object
8 properties
2 required
SearchInputMultiValueUiBlock
object
A multi-select search input block for selecting multiple Benchling entities.
9 properties
SearchInputMultiValueUiBlockInput
object
9 properties
3 required
SearchInputUiBlock
object
A search input block for selecting a single Benchling entity.
9 properties
SearchInputUiBlockInput
object
9 properties
3 required
SectionContentInput
object
3 properties
1 required
SectionDocumentContent
object
Represents a section divider within notebook or document content. Sections can include a title, date, and color to group related document parts.
4 properties
SectionUiBlock
object
A section block that groups child blocks together. Children are leaf blocks only.
3 properties
SectionUiBlockInput
object
3 properties
3 required
SecureTextAppConfigSpec
object
Specifies that an app configuration field should accept secure (encrypted) text. Used for sensitive data like API keys or credentials.
2 properties
SecureTextAppConfigValue
object
Stores a secure (encrypted) text value in an app configuration field. Used for sensitive data like API keys or credentials.
2 properties
SelectorInput
object
4 properties
SelectorInputMultiValueUiBlock
object
A multi-select selector input block with predefined options.
8 properties
SelectorInputMultiValueUiBlockInput
object
8 properties
3 required
SelectorInputUiBlock
object
A selector input block with predefined options.
8 properties
SelectorInputUiBlockInput
object
8 properties
3 required
ServicePrincipal
object
Represents a non-human identity used for system integrations and automated processes within Benchling. Service principals act as the identity for service accou…
4 properties
ServicePrincipalPaginatedList
object
2 properties
SingleTransferInput
object
6 properties
2 required
SplitTransform
object
A data transform that divides values in a single column into multiple output columns by splitting on a delimiter.
3 properties
SplitTransformationProperties
object
Properties for a SPLIT transform, specifying the column to split, the delimiter to split on, and the names for the resulting output columns.
4 properties
SqlDashboard
object
A SqlDashboard is a configurable analytics page that displays one or more SQL-driven visualizations within Benchling Insights. Dashboards belong to a Project a…
9 properties
SqlDashboardBlock
object
Represents a single query and visualization pane within a SqlDashboard. Each block contains a SQL query (sqlQuery) that runs against the Benchling data warehou…
6 properties
SqlDashboardBlockPaginatedList
object
2 properties
SqlDashboardBlockUnpaginatedList
object
1 property
SqlDashboardPaginatedList
object
2 properties
StageEntry
object
A StageEntry is an Entry that is associated with a specific stage in a legacy Workflow. Unlike regular Entries which exist independently in folders, StageEntri…
17 properties
StageEntryPaginatedList
object
2 properties
StandardReactionComponent
object
Generic type for most reaction components
15 properties
StorableLinkFieldDefinition
object
A schema field definition for linking to storable inventory items.
12 properties
StringValueFilterTransformationProperties
object
Properties for a FILTER transform that filters rows by comparing a column's string value using equality or inequality.
4 properties
Study
object
A structured unit used to plan and organize research in Benchling. Each study progresses through phases (see StudyPhase) sequentially from design to execution…
19 properties
StudyItemAssociation
object
Represents the link between a Study and a Studyable item (such as entities or molecules). Each association is identified by id and links a specific study to a…
6 properties
StudyItemAssociationPaginatedList
object
2 properties
StudyPaginatedList
object
2 properties
StudyRef
object
2 properties
StudySchema
object
A configuration template that defines the structure and behavior of Studies within an organization. Each StudySchema specifies the studyType, which determines…
16 properties
StudySchemaPaginatedList
object
2 properties
StudySchemaRef
object
2 properties
StudyableRef
object
2 properties
SystemCategoryConfiguration
object
SystemCategoryConfigurationInputBase
object
SystemCategoryLinkFieldDefinition
object
A schema field definition for linking to entities that implement a system category (static schema interface).
12 properties
TableCellSelector
object
A predefined dropdown selector that can be assigned to table cells.
4 properties
TableColumnDefinition
object
A column definition within a table, specifying the label and optional width.
4 properties
TableUiBlock
object
A table block that displays tabular data from a dataset or data frame.
5 properties
TableUiBlockInput
object
5 properties
4 required
TaskTransitionExtension
object
Records a status change event on a method task during procedure execution. Captures the comment provided, the human-readable status name, and the timestamp whe…
4 properties
Team
object
Represents a subgroup of users within an Organization, enabling finer-grained user management and data sharing. Teams belong to exactly one organization, and u…
9 properties
TeamPaginatedList
object
2 properties
TeamRef
object
2 properties
TemplateCollectible
object
TemplateCollectibleUnpaginatedList
object
1 property
TemplateCollection
object
A container that organizes related templates, subtemplates, and other template-like items. Template Collections provide a way to group and manage reusable cont…
10 properties
TemplateCollectionPaginatedList
object
2 properties
TemplateCollectionRef
object
2 properties
TestDefinition
object
A Test Definition is a configuration object that specifies a type of test or assay that can be ordered against samples. Each Test Definition is associated with…
13 properties
TestDefinitionPaginatedList
object
2 properties
TestDefinitionRef
object
2 properties
TestOrder
object
A Test Order represents an individual request to perform a specific test on a sample. Each Test Order references a TestDefinition that specifies what type of t…
14 properties
TestOrderPaginatedList
object
2 properties
TextAndUrlValue
object
A type that represents text (string) values with an associated URL.
3 properties
TextAppConfigSpec
object
Specifies that an app configuration field should accept a text string.
3 properties
TextAppConfigValue
object
Stores a text string value in an app configuration field.
2 properties
TextBoxDocumentContent
object
Represents a fill-in text box within a notebook entry. Text boxes are labeled input fields that can be added to entry templates to capture specific pieces of i…
9 properties
TextContentInput
object
6 properties
2 required
TextDocumentContent
object
Represents a paragraph of formatted text content within a notebook entry or document. TextDocumentContent is the primary way to store narrative text in the ele…
6 properties
TextFieldDefinition
object
A text field definition for short, single-line text values.
11 properties
TextFormat
object
A TextFormat applies a set of TextFormatProperties to some range within a text. Examples here would include font properties like bold, italic or underline as w…
6 properties
TextFormatInput
object
5 properties
TextInputUiBlock
object
A text input block that accepts freeform user text.
7 properties
TextInputUiBlockInput
object
7 properties
2 required
TextNameTemplatePartConfiguration
object
Configuration for a literal text name template part.
2 properties
TextNameTemplatePartConfigurationInput
object
1 property
1 required
TextValue
object
A type that represents text (string) values.
2 properties
Transcription
object
Represents a transcribed region on a DNA sequence that produces an RNA product. Transcriptions link a region of a DnaSequence to the corresponding RnaSequence…
5 properties
TranscriptionLinkFieldDefinition
object
A schema field definition for linking to transcriptions (RNA sequences created from DNA).
14 properties
TransferInput
object
1 property
1 required
TransferOutput
object
Result of a Container.transfer call: the IDs of the destination containers that were updated.
1 property
TransferScratchPlatesResult
object
The scratch plate(s) produced by a transfer.
3 properties
Translation
object
Represents a protein-coding region (CDS) on a nucleotide sequence, showing the translated amino acid sequence. Translations can span a single contiguous region…
12 properties
TranslationInput
object
8 properties
2 required
TranslationLinkFieldDefinition
object
A schema field definition for linking to translations (AA sequences created from RNA).
13 properties
TranslationRegionInput
object
2 properties
2 required
UiBlockLeafNodeInput
object
Unit
object
A Unit is a specific measure of a physical quantity within Benchling's tenant-specific unit dictionary, used to capture and convert scientific measurements acr…
13 properties
UnitInput
object
1 property
UnitPaginatedList
object
2 properties
UnitRef
object
2 properties
UnitType
object
A UnitType is a dimensional category that groups inter-convertible Unit objects within Benchling's tenant-specific unit dictionary. Examples include Volume, Ma…
15 properties
UnitTypePaginatedList
object
2 properties
UnitTypeRef
object
2 properties
UnitTypeTerm
object
A term in the dimensional formula of a UnitType, pairing one of the seven SI base dimensions (see BaseUnitType) with an integer exponent. Multiple terms togeth…
3 properties
UnitUnpaginatedList
object
1 property
UnresolvableEmbeddedItem
object
An embedded Benchling item that exists in the system but cannot be fetched via the V3 REST API (currently Protocols, Equipment, and Trial Subjects). It has no…
2 properties
UnstructuredTableCellFormatInput
object
5 properties
UnstructuredTableCellInput
object
5 properties
1 required
UnstructuredTableCellInputValue
object
2 properties
2 required
UnstructuredTableColumnInput
object
3 properties
1 required
UnstructuredTableContentInput
object
4 properties
4 required
UnstructuredTableDocumentContentSummary
object
An unstructured (plain) table embedded within a notebook entry. Unlike structured tables, unstructured tables have freeform cells without typed columns. Cells…
6 properties
UnstructuredTableMergeRangeInput
object
2 properties
2 required
UnstructuredTableMergeRangeParentInput
object
2 properties
2 required
UnstructuredTableRowInput
object
1 property
1 required
UpdateAaPartLinkFieldDefinitionInput
object
11 properties
7 required
UpdateAaSequenceInput
object
14 properties
UpdateAaSequenceInputWithPathParams
object
15 properties
1 required
UpdateAaSequenceLinkFieldDefinitionInput
object
11 properties
7 required
UpdateAaSequenceSchemaInput
object
17 properties
UpdateAaSequenceSchemaInputWithPathParams
object
18 properties
1 required
UpdateAntibodyLinkFieldDefinitionInput
object
11 properties
7 required
UpdateAntibodySchemaInput
object
14 properties
UpdateAntibodySchemaInputWithPathParams
object
15 properties
1 required
UpdateAnyEntityLinkFieldDefinitionInput
object
9 properties
6 required
UpdateAppCanvasInput
object
6 properties
UpdateAppCanvasInputWithPathParams
object
7 properties
1 required
UpdateAppSessionInput
object
3 properties
UpdateAppSessionInputWithPathParams
object
4 properties
1 required
UpdateAssayRequestLinkFieldDefinitionInput
object
10 properties
7 required
UpdateAssayResultLinkFieldDefinitionInput
object
10 properties
7 required
UpdateAssayRunLinkFieldDefinitionInput
object
10 properties
7 required
UpdateBlobLinkFieldDefinitionInput
object
9 properties
6 required
UpdateBooleanFieldDefinitionInput
object
8 properties
5 required
UpdateBoxInput
object
7 properties
UpdateBoxInputWithPathParams
object
8 properties
1 required
UpdateBoxSchemaInput
object
10 properties
UpdateBoxSchemaInputWithPathParams
object
11 properties
1 required
UpdateChartInput
object
3 properties
UpdateChartInputWithPathParams
object
4 properties
1 required
UpdateCollaborationInput
object
2 properties
UpdateCollaborationInputWithPathParams
object
3 properties
1 required
UpdateContainerInput
object
12 properties
UpdateContainerInputWithPathParams
object
13 properties
1 required
UpdateContainerSchemaInput
object
7 properties
UpdateContainerSchemaInputWithPathParams
object
8 properties
1 required
UpdateCustomEntityInput
object
12 properties
UpdateCustomEntityInputWithPathParams
object
13 properties
1 required
UpdateCustomEntityLinkFieldDefinitionInput
object
11 properties
7 required
UpdateCustomEntitySchemaInput
object
16 properties
UpdateCustomEntitySchemaInputWithPathParams
object
17 properties
1 required
UpdateDateFieldDefinitionInput
object
8 properties
5 required
UpdateDateTimeFieldDefinitionInput
object
8 properties
5 required
UpdateDnaOligoInput
object
17 properties
UpdateDnaOligoInputWithPathParams
object
18 properties
1 required
UpdateDnaOligoLinkFieldDefinitionInput
object
11 properties
7 required
UpdateDnaOligoSchemaInput
object
17 properties
UpdateDnaOligoSchemaInputWithPathParams
object
18 properties
1 required
UpdateDnaPartLinkFieldDefinitionInput
object
11 properties
7 required
UpdateDnaSequenceInput
object
18 properties
UpdateDnaSequenceInputWithPathParams
object
19 properties
1 required
UpdateDnaSequenceLinkFieldDefinitionInput
object
11 properties
7 required
UpdateDnaSequenceSchemaInput
object
17 properties
UpdateDnaSequenceSchemaInputWithPathParams
object
18 properties
1 required
UpdateDocumentPartsInput
object
UpdateDropdownInput
object
4 properties
UpdateDropdownInputWithPathParams
object
5 properties
1 required
UpdateDropdownLinkFieldDefinitionInput
object
10 properties
7 required
UpdateDropdownOptionInput
object
4 properties
1 required
UpdateEntryInput
object
9 properties
UpdateEntryInputWithPathParams
object
10 properties
1 required
UpdateEntryLinkFieldDefinitionInput
object
9 properties
6 required
UpdateEquipmentLinkFieldDefinitionInput
object
11 properties
7 required
UpdateEquipmentSchemaInput
object
16 properties
UpdateEquipmentSchemaInputWithPathParams
object
17 properties
1 required
UpdateFieldValueInput
object
2 properties
2 required
UpdateFieldsetInput
object
10 properties
UpdateFieldsetInputWithPathParams
object
11 properties
1 required
UpdateFieldsetLinkFieldDefinitionInput
object
10 properties
7 required
UpdateFileInput
object
4 properties
UpdateFileInputWithPathParams
object
5 properties
1 required
UpdateFloatFieldDefinitionInput
object
12 properties
5 required
UpdateFolderInput
object
4 properties
UpdateFolderInputWithPathParams
object
5 properties
1 required
UpdateIntegerFieldDefinitionInput
object
11 properties
5 required
UpdateLibraryParameterDefinitionInput
object
4 properties
UpdateLibraryParameterDefinitionInputWithPathParams
object
5 properties
1 required
UpdateLocationInput
object
6 properties
UpdateLocationInputWithPathParams
object
7 properties
1 required
UpdateLocationSchemaInput
object
7 properties
UpdateLocationSchemaInputWithPathParams
object
8 properties
1 required
UpdateLongTextFieldDefinitionInput
object
8 properties
5 required
UpdateMatrixPlateInput
object
7 properties
UpdateMatrixPlateInputWithPathParams
object
8 properties
1 required
UpdateMatrixPlateSchemaInput
object
10 properties
UpdateMatrixPlateSchemaInputWithPathParams
object
11 properties
1 required
UpdateMixtureLinkFieldDefinitionInput
object
11 properties
7 required
UpdateMixtureSchemaInput
object
19 properties
UpdateMixtureSchemaInputWithPathParams
object
20 properties
1 required
UpdateMoleculeInput
object
13 properties
UpdateMoleculeInputWithPathParams
object
14 properties
1 required
UpdateMoleculeLinkFieldDefinitionInput
object
11 properties
7 required
UpdateMoleculeSchemaInput
object
16 properties
UpdateMoleculeSchemaInputWithPathParams
object
17 properties
1 required
UpdateOligoConjugateLinkFieldDefinitionInput
object
11 properties
7 required
UpdateOligoConjugateSchemaInput
object
16 properties
UpdateOligoConjugateSchemaInputWithPathParams
object
17 properties
1 required
UpdateOligoDuplexLinkFieldDefinitionInput
object
11 properties
7 required
UpdateOligoDuplexSchemaInput
object
16 properties
UpdateOligoDuplexSchemaInputWithPathParams
object
17 properties
1 required
UpdatePlateDesignTemplateInput
object
3 properties
UpdatePlateDesignTemplateInputWithPathParams
object
4 properties
1 required
UpdateProcedureRunPlanConditionInput
object
5 properties
UpdateProcedureRunPlanConditionInputWithPathParams
object
6 properties
1 required
UpdateProcedureRunPlanInput
object
5 properties
UpdateProcedureRunPlanInputWithPathParams
object
6 properties
1 required
UpdateProjectInput
object
8 properties
UpdateProjectInputWithPathParams
object
9 properties
1 required
UpdateProteinFormatInput
object
3 properties
UpdateProteinFormatInputWithPathParams
object
4 properties
1 required
UpdateProteinInput
object
15 properties
UpdateProteinInputWithPathParams
object
16 properties
1 required
UpdateReactionInput
object
2 properties
UpdateReactionInputWithPathParams
object
3 properties
1 required
UpdateRequestV2DefinitionInput
object
6 properties
UpdateRequestV2DefinitionInputWithPathParams
object
7 properties
1 required
UpdateResultInput
object
3 properties
UpdateResultInputWithPathParams
object
4 properties
1 required
UpdateRnaOligoInput
object
17 properties
UpdateRnaOligoInputWithPathParams
object
18 properties
1 required
UpdateRnaOligoLinkFieldDefinitionInput
object
11 properties
7 required
UpdateRnaOligoSchemaInput
object
17 properties
UpdateRnaOligoSchemaInputWithPathParams
object
18 properties
1 required
UpdateRnaSequenceInput
object
21 properties
UpdateRnaSequenceInputWithPathParams
object
22 properties
1 required
UpdateRnaSequenceLinkFieldDefinitionInput
object
11 properties
7 required
UpdateRnaSequenceSchemaInput
object
17 properties
UpdateRnaSequenceSchemaInputWithPathParams
object
18 properties
1 required
UpdateScratchFileInput
object
2 properties
1 required
UpdateScratchFileInputWithPathParams
object
3 properties
2 required
UpdateScratchPlateInput
object
8 properties
UpdateScratchPlateInputWithPathParams
object
9 properties
1 required
UpdateSqlDashboardBlockInput
object
3 properties
UpdateSqlDashboardBlockInputWithPathParams
object
4 properties
1 required
UpdateStorableLinkFieldDefinitionInput
object
10 properties
7 required
UpdateStudyInput
object
10 properties
UpdateStudyInputWithPathParams
object
11 properties
1 required
UpdateStudySchemaInput
object
10 properties
UpdateStudySchemaInputWithPathParams
object
11 properties
1 required
UpdateSystemCategoryLinkFieldDefinitionInput
object
10 properties
7 required
UpdateTestDefinitionInput
object
6 properties
UpdateTestDefinitionInputWithPathParams
object
7 properties
1 required
UpdateTextFieldDefinitionInput
object
8 properties
5 required
UpdateTranscriptionLinkFieldDefinitionInput
object
11 properties
7 required
UpdateTranslationLinkFieldDefinitionInput
object
11 properties
7 required
UpdateUnitInput
object
5 properties
UpdateUnitInputWithPathParams
object
6 properties
1 required
UpdateUnitTypeInput
object
7 properties
UpdateUnitTypeInputWithPathParams
object
8 properties
1 required
UpdateWarehouseCredentialInput
object
1 property
1 required
UpdateWarehouseCredentialInputWithPathParams
object
2 properties
2 required
UpdateWellPlateInput
object
7 properties
UpdateWellPlateInputWithPathParams
object
8 properties
1 required
UpdateWellPlateSchemaInput
object
10 properties
UpdateWellPlateSchemaInputWithPathParams
object
11 properties
1 required
UpdateWorkflowOutputInput
object
1 property
UpdateWorkflowOutputInputWithPathParams
object
2 properties
1 required
UpdateWorkflowTaskGroupInput
object
4 properties
UpdateWorkflowTaskGroupInputWithPathParams
object
5 properties
1 required
UpdateWorkflowTaskInput
object
5 properties
UpdateWorkflowTaskInputWithPathParams
object
6 properties
1 required
UpdateWorklistInput
object
4 properties
UpdateWorklistInputWithPathParams
object
5 properties
1 required
UseNameAsBarcodeInput
object
2 properties
2 required
User
object
Represents a human user in Benchling who can log in, perform actions, and own data. Users belong to one or more Organizations and may be members of Teams withi…
9 properties
UserPaginatedList
object
2 properties
UserRef
object
2 properties
V3EventBase
object
Fields common to every v3 event message.
6 properties
6 required
V3UpdateEventBase
Fields common to every v3 update event message.
WarehouseCredential
object
Represents credentials for connecting to Benchling's data warehouse, enabling users to query data using SQL tools like database clients or BI platforms. This i…
9 properties
WarehouseCredentialPaginatedList
object
2 properties
WarehouseCredentialRef
object
2 properties
WarehouseCustomView
object
A custom SQL view created by users in Benchling's data warehouse, allowing them to define reusable queries that can be accessed like tables. Views appear in a…
9 properties
WarehouseCustomViewPaginatedList
object
2 properties
WebhookApp
object
The Benchling App the webhook was delivered to.
1 property
1 required
WebhookAppDefinition
object
The app definition the receiving app was installed from.
2 properties
2 required
WebhookEnvelopeBaseV0
object
Fields common to every webhook request body. The event itself is carried in the message property of the event-specific payload.
5 properties
5 required
WellPlate
WellPlatePaginatedList
object
2 properties
WellPlatePosition
object
Represents a single well within a WellPlate, functioning as a fixed container at a specific grid position. Each WellPlatePosition has coordinates identifying i…
11 properties
WellPlatePositionPaginatedList
object
2 properties
WellPlatePositionUnpaginatedList
object
1 property
WellPlateSchema
object
Defines the structure and constraints for a category of WellPlates in Benchling's inventory system. A WellPlateSchema specifies the grid dimensions (height and…
15 properties
WellPlateSchemaPaginatedList
object
2 properties
WellPlateSchemaRef
object
2 properties
WellRoleInput
object
3 properties
1 required
WellTransferInput
object
9 properties
3 required
WorkflowOutput
object
Represents the result or product of completing a WorkflowTask. Each output is associated with a single task. Outputs can contain schema-defined fields that cap…
11 properties
WorkflowOutputPaginatedList
object
2 properties
WorkflowOutputSchema
object
Defines the structure of WorkflowOutput instances produced by tasks of a given WorkflowTaskSchema. Each output schema specifies fieldDefinitions for the data t…
11 properties
WorkflowOutputSchemaPaginatedList
object
2 properties
WorkflowOutputSchemaRef
object
2 properties
WorkflowTask
object
Represents a unit of work within a WorkflowTaskGroup. Each task has a status that progresses through a configurable lifecycle (see WorkflowTaskStatusLifecycle)…
21 properties
WorkflowTaskGroup
object
A container that groups related WorkflowTask instances together, representing a cohesive unit of work. Task groups are created from a WorkflowTaskSchema (via w…
16 properties
WorkflowTaskGroupPaginatedList
object
2 properties
WorkflowTaskGroupRef
object
2 properties
WorkflowTaskGroupUnpaginatedList
object
1 property
WorkflowTaskPaginatedList
object
2 properties
WorkflowTaskRef
object
2 properties
WorkflowTaskSchema
object
A configuration template that defines the structure and behavior of WorkflowTask instances. Each schema specifies an executionType (direct, entry, or flowchart…
22 properties
WorkflowTaskSchemaAppConfigSpec
object
Specifies that an app configuration field should reference a workflow task schema. Kept separate from SchemaAppConfigSpec because it supports output field defi…
4 properties
WorkflowTaskSchemaPaginatedList
object
2 properties
WorkflowTaskSchemaRef
object
2 properties
WorkflowTaskUnpaginatedList
object
1 property
Worklist
object
A typed collection of items used to group related objects for batch operations. Unlike folders, items can belong to multiple worklists simultaneously, making w…
9 properties
WorklistPaginatedList
object
2 properties
Worklistable
object
WorklistableUnpaginatedList
object
1 property
Worksheet
object
A structured document container used to organize and execute procedural work within Benchling's notebook system. Worksheets contain ordered WorksheetStepGroups…
15 properties
WorksheetPaginatedList
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Benchling 12
Other APIs Benchling publishes across the network.
Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
#REST#Unified-API#Electronic Lab Notebook#Registry#Inventory#Assay Results#Workflows#Webhook
Where this information came from
This is an independent, third-party profile of Benchling API v3, 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.