generated: '2026-10-12' method: derived generator: derive-vocabulary.py source: - openapi/benchling-aa-sequences-api-openapi.yml - openapi/benchling-aasequence-api-openapi.yml - openapi/benchling-aasequenceschema-api-openapi.yml - openapi/benchling-agent-api-openapi.yml - openapi/benchling-analysis-api-openapi.yml vocabulary: name: Benchling Domain Vocabulary description: 'Terms declared by Benchling''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-12' terms: - term: AA Sequences definition: AA Sequences are the working units of cells that make everything run (they help make structures, catalyze reactions and allow for signaling - a kind of internal cell communication). On Benchling, these are comprised of a string of amino acids and collections of other attributes, such as annotations. tags: - Resource Group source: openapi/benchling-aa-sequences-api-openapi.yml - term: AaSequence definition: Represents an amino acid sequence in Benchling's molecular biology platform. tags: - Resource Group source: openapi/benchling-aasequence-api-openapi.yml - term: AaSequenceSchema definition: Defines the structure, field definitions, and configuration options for AA sequences. tags: - Resource Group source: openapi/benchling-aasequenceschema-api-openapi.yml - term: Analysis definition: Operations for Analysis tags: - Resource Group source: openapi/benchling-analysis-api-openapi.yml - term: AnalysisTemplate definition: A reusable pipeline configuration that can be instantiated to create new Analysis objects. tags: - Resource Group source: openapi/benchling-analysistemplate-api-openapi.yml - term: AnalysisTemplateDataFrameVariable definition: Defines a data frame placeholder within an AnalysisTemplate that users must provide when applying the template. tags: - Resource Group source: openapi/benchling-analysistemplatedataframevariable-api-openapi.yml - term: AnalysisTemplateVariable definition: Defines a configuration parameter within an AnalysisTemplate that users can customize when applying the template. tags: - Resource Group source: openapi/benchling-analysistemplatevariable-api-openapi.yml - term: App Installation definition: Represents an installed Benchling App on a tenant, created from an `AppDefinitionVersion`. App installations store tenant-specific configuration values and feature bindings. As a Principal, app installations can be attributed as actors for API operations and auditing. tags: - Resource Group source: openapi/benchling-app-installation-api-openapi.yml - term: AppCanvas definition: 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. Each canvas belongs to a single app and contains a list of UI blocks that define the canvas layout and interactivity. tags: - Resource Group source: openapi/benchling-appcanvas-api-openapi.yml - term: AppConfigValue definition: 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 containing the actual value. Config values are defined by the app's configuration spec and set during installation or later configuration. tags: - Resource Group source: openapi/benchling-appconfigvalue-api-openapi.yml - term: Apps definition: Create and manage Benchling apps on your tenant tags: - Resource Group source: openapi/benchling-apps-api-openapi.yml - term: AppSession definition: 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 belongs to a single app installation and progresses through a lifecycle from RUNNING to a terminal status. Sessions are updated by appending new versions, which can change the status, timeout, and displayed messages. tags: - Resource Group source: openapi/benchling-appsession-api-openapi.yml - term: Assay Results definition: Results represent the output of assays that have been performed. You can customize the schemas of results to fit your needs. Results can link to runs, entities, and other types. To learn more about creating results, click here. tags: - Resource Group source: openapi/benchling-assay-results-api-openapi.yml - term: Assay Runs definition: Runs capture the details / parameters of a run that was performed. Results are usually nested under a run. tags: - Resource Group source: openapi/benchling-assay-runs-api-openapi.yml - term: Assembly definition: Represents a molecular cloning assembly that combines multiple DNA fragments into complete constructs. Assemblies model the process of joining fragment sequences (such as genes, promoters, and terminators) using methods like Gibson Assembly, Golden Gate, or restriction enzyme-based cloning. The assembly tracks the input fragments and resulting construct sequences, enabling design-to-experiment tra tags: - Resource Group source: openapi/benchling-assembly-api-openapi.yml - term: Audit definition: Export audit log data for Benchling objects. tags: - Resource Group source: openapi/benchling-audit-api-openapi.yml - term: Audit Log definition: 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. tags: - Resource Group source: openapi/benchling-audit-log-api-openapi.yml - term: Authentication definition: Endpoints to help authenticate with the rest of the API resources. tags: - Resource Group source: openapi/benchling-authentication-api-openapi.yml - term: Blobs definition: Blobs are opaque files that can be linked to other items in Benchling, like assay runs or results. For example, you can upload a blob, then upload an assay result that links to that blob by ID. The blob will then appear as part of the assay result in the Benchling web UI. tags: - Resource Group source: openapi/benchling-blobs-api-openapi.yml - term: Box definition: 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. tags: - Resource Group source: openapi/benchling-box-api-openapi.yml - term: Boxes definition: Boxes are a structured inventory type, consisting of a grid of positions that can each hold one container. Unlike locations, there are a maximum number of containers that a box can hold (one per position). Boxes are all associated with schemas, which define the type of the box (e.g. "10x10 Cryo Box") along with the fields that are tracked and the dimensions of the box. Like all inventory, every Bo tags: - Resource Group source: openapi/benchling-boxes-api-openapi.yml - term: BoxSchema definition: Defines the structure and constraints for a category of Boxes in Benchling's inventory system. tags: - Resource Group source: openapi/benchling-boxschema-api-openapi.yml - term: Chart definition: A Chart is a data visualization within Benchling. tags: - Resource Group source: openapi/benchling-chart-api-openapi.yml - term: Codon Usage Tables definition: Benchling curates codon usage data for a variety of organisms to support operations such as Codon Optimization and Back Translation. tags: - Resource Group source: openapi/benchling-codon-usage-tables-api-openapi.yml - term: Collaboration definition: 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 with the Principal or Group. tags: - Resource Group source: openapi/benchling-collaboration-api-openapi.yml - term: ConfigImportHistoryEntry definition: 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 optional changelog URL documenting the changes. This provides an audit trail for configuration migrations between tenants. tags: - Resource Group source: openapi/benchling-configimporthistoryentry-api-openapi.yml - term: Connect definition: Connect endpoints support Benchling Connect actions, like instrument data conversion. tags: - Resource Group source: openapi/benchling-connect-api-openapi.yml - term: Container definition: A Container is a physical vessel (such as a tube, vial, or cryotube) that holds biological or chemical samples in Benchling's inventory system. tags: - Resource Group source: openapi/benchling-container-api-openapi.yml - term: Containers definition: Containers are the backbone of sample management in Benchling. tags: - Resource Group source: openapi/benchling-containers-api-openapi.yml - term: ContainerSchema definition: Defines the structure and metadata for a category of Containers in Benchling's inventory system. tags: - Resource Group source: openapi/benchling-containerschema-api-openapi.yml - term: Custom Entities definition: Benchling supports custom entities for biological entities that are neither DNA, RNA, nor AA sequences. Custom entities must have an entity schema set and can have both schema fields and custom fields. tags: - Resource Group source: openapi/benchling-custom-entities-api-openapi.yml - term: Custom Notations definition: Benchling allows users to configure their own fully-custom string representation formats for import/export of nucleotide sequences (including chemical modifications). tags: - Resource Group source: openapi/benchling-custom-notations-api-openapi.yml - term: CustomEntity definition: A flexible, user-defined entity type in Benchling's Registry. tags: - Resource Group source: openapi/benchling-customentity-api-openapi.yml - term: CustomEntitySchema definition: Operations for CustomEntitySchema tags: - Resource Group source: openapi/benchling-customentityschema-api-openapi.yml - term: Data Frames definition: Data frames in Benchling represent tabular data that is not schematized. They contain columns with defined types and rows of data. Data frames are primarily used within specific Benchling applications. For example, in Benchling Analysis, each table is represented as a dataframe that is visible only within the analysis. tags: - Resource Group source: openapi/benchling-data-frames-api-openapi.yml - term: DataFrame definition: '`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 are child objects of pipelines (via `PipelineStepData`), datasets (see `Dataset`), and app canvases. Row data is stored in S3. Data frames are immutable; if data is updated, a new `DataFrame` is created.' tags: - Resource Group source: openapi/benchling-dataframe-api-openapi.yml - term: Dataset definition: '`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 a `DataFrame`.' tags: - Resource Group source: openapi/benchling-dataset-api-openapi.yml - term: Datasets definition: Similar to Data frames, datasets in Benchling represent tabular data that is not schematized. Datasets are saved to folders within Benchling with additional metadata, making them accessible and searchable within Benchling. Each dataset actually contains a data frame, and a data frame is required to create a dataset. tags: - Resource Group source: openapi/benchling-datasets-api-openapi.yml - term: DNA Alignments definition: A DNA alignment is a Benchling object representing an alignment of multiple DNA sequences. This endpoint is deprecated, please migrate to the existing Nucleotide Alignments endpoints. tags: - Resource Group source: openapi/benchling-dna-alignments-api-openapi.yml - term: DNA Oligos definition: DNA Oligos are short linear DNA sequences that can be attached as primers to full DNA sequences. Just like other entities, they support schemas, tags, and aliases. tags: - Resource Group source: openapi/benchling-dna-oligos-api-openapi.yml - term: DNA Sequences definition: DNA sequences are the bread and butter of the Benchling Molecular Biology suite. On Benchling, these are comprised of a string of nucleotides and collections of other attributes, such as annotations and primers. tags: - Resource Group source: openapi/benchling-dna-sequences-api-openapi.yml - term: DnaOligo definition: Represents a short single-stranded DNA oligonucleotide in Benchling's molecular biology platform. tags: - Resource Group source: openapi/benchling-dnaoligo-api-openapi.yml - term: DnaOligoSchema definition: Defines the structure, field definitions, and configuration options for DNA oligos. tags: - Resource Group source: openapi/benchling-dnaoligoschema-api-openapi.yml - term: DnaSequence definition: Represents a DNA sequence in Benchling's molecular biology platform. tags: - Resource Group source: openapi/benchling-dnasequence-api-openapi.yml - term: DnaSequenceSchema definition: Defines the structure, field definitions, and configuration options for DNA sequences. tags: - Resource Group source: openapi/benchling-dnasequenceschema-api-openapi.yml - term: DocumentPart definition: 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 audit metadata. tags: - Resource Group source: openapi/benchling-documentpart-api-openapi.yml - term: Dropdown definition: A configurable list of predefined values used for standardizing data entry in schema fields. tags: - Resource Group source: openapi/benchling-dropdown-api-openapi.yml - term: DropdownLinkFieldDefinition definition: 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 `isMulti` is true, users can select multiple dropdown options for a single field value. The dropdown provides controlled vocabulary for consistent data entry across the organization. tags: - Resource Group source: openapi/benchling-dropdownlinkfielddefinition-api-openapi.yml - term: DropdownOption definition: 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 Dropdown. Options can be archived to remove them from the available choices while preserving historical data that references them. The option's name is displayed to users when selecting values. tags: - Resource Group source: openapi/benchling-dropdownoption-api-openapi.yml - term: Dropdowns definition: Dropdowns are registry-wide enums. Use dropdowns to standardize on spelling and naming conventions, especially for important metadata like resistance markers. tags: - Resource Group source: openapi/benchling-dropdowns-api-openapi.yml - term: Entities definition: Entities include DNA and AA sequences, oligos, molecules, custom entities, and other biological objects in Benchling. Entities support schemas, tags, and aliases, and can be registered. tags: - Resource Group source: openapi/benchling-entities-api-openapi.yml - term: EntitySchema definition: Defines the structure and behavior for a category of registered entities in Benchling. tags: - Resource Group source: openapi/benchling-entityschema-api-openapi.yml - term: Entries definition: Entries are rich text documents that allow you to capture all of your experimental data in one place. tags: - Resource Group source: openapi/benchling-entries-api-openapi.yml - term: Entry definition: An Entry is the core document type in Benchling's Electronic Lab Notebook (ELN), used by scientists to record experimental work and observations. tags: - Resource Group source: openapi/benchling-entry-api-openapi.yml - term: EntrySchema definition: 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 notebook entries by defining required or optional fields with specific data types. tags: - Resource Group source: openapi/benchling-entryschema-api-openapi.yml - term: EntrySubtemplate definition: A reusable content block that can be inserted into `DocumentLike` objects. tags: - Resource Group source: openapi/benchling-entrysubtemplate-api-openapi.yml - term: EntryTemplate definition: A template used to create new `DocumentLike` objects with pre-populated content and structure. tags: - Resource Group source: openapi/benchling-entrytemplate-api-openapi.yml - term: Enzyme definition: Represents a restriction enzyme from Benchling's global catalog of commercially available enzymes. tags: - Resource Group source: openapi/benchling-enzyme-api-openapi.yml - term: EnzymeList definition: Represents a user-curated collection of restriction enzymes for molecular cloning workflows. EnzymeLists allow users and organizations to organize commonly used enzymes into named groups for easy access when planning restriction digests, cloning strategies, or analyzing DNA sequences. Each list has an owner (either a user or organization) who controls access permissions. See `Enzyme` for the indiv tags: - Resource Group source: openapi/benchling-enzymelist-api-openapi.yml - term: Enzymes definition: Restriction enzymes are curated by Benchling for operations such as Digests and Codon Optimization. tags: - Resource Group source: openapi/benchling-enzymes-api-openapi.yml - term: EquipmentSchema definition: Defines the structure, field definitions, and configuration options for Equipments. tags: - Resource Group source: openapi/benchling-equipmentschema-api-openapi.yml - term: Events definition: The Events system allows external services to subscribe to events that are triggered in Benchling (e.g. plasmid registration, request submission, etc). tags: - Resource Group source: openapi/benchling-events-api-openapi.yml - term: EventSubscription definition: Configures delivery of Benchling events to external systems via AWS EventBridge. tags: - Resource Group source: openapi/benchling-eventsubscription-api-openapi.yml - term: Exports definition: Export a Notebook Entry or a Legacy Workflow Stage Entry. tags: - Resource Group source: openapi/benchling-exports-api-openapi.yml - term: Feature Libraries definition: Feature Libraries are collections of shared canonical patterns that can be used to generate annotations on matching regions of DNA Sequences or AA Sequences. tags: - Resource Group source: openapi/benchling-feature-libraries-api-openapi.yml - term: FeatureLibrary definition: Represents a reusable collection of biological features for auto-annotating nucleotide and AA sequences. tags: - Resource Group source: openapi/benchling-featurelibrary-api-openapi.yml - term: FeatureLibraryItem definition: Represents a single feature definition within a FeatureLibrary used for auto-annotation. tags: - Resource Group source: openapi/benchling-featurelibraryitem-api-openapi.yml - term: Fieldset definition: A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. tags: - Resource Group source: openapi/benchling-fieldset-api-openapi.yml - term: File definition: A File represents an uploaded document or data file that is surfaced in Benchling's Data Catalog for discovery and organization. tags: - Resource Group source: openapi/benchling-file-api-openapi.yml - term: Files definition: Files are Benchling objects that represent files and their metadata. Compared to Blobs, which are used by most Benchling products for attachments, Files are primarily used in the Analysis and Connect product. tags: - Resource Group source: openapi/benchling-files-api-openapi.yml - term: Folder definition: A hierarchical container for organizing entities, notebook entries, and other items within a Project. tags: - Resource Group source: openapi/benchling-folder-api-openapi.yml - term: Folders definition: Folders are nested within projects to provide additional organization. tags: - Resource Group source: openapi/benchling-folders-api-openapi.yml - term: Germline definition: A database of reference sequences used to characterize protein sequences via alignment. tags: - Resource Group source: openapi/benchling-germline-api-openapi.yml - term: GroupMembership definition: 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 Group. tags: - Resource Group source: openapi/benchling-groupmembership-api-openapi.yml - term: Instrument Queries definition: Instrument Queries are used to query the instrument service. tags: - Resource Group source: openapi/benchling-instrument-queries-api-openapi.yml - term: Inventory definition: Manage inventory wide objects. tags: - Resource Group source: openapi/benchling-inventory-api-openapi.yml - term: Lab Automation definition: Lab Automation endpoints support integration with lab instruments, and liquid handlers to create samples or results, and capture transfers between containers at scale. tags: - Resource Group source: openapi/benchling-lab-automation-api-openapi.yml - term: Label Templates definition: List label templates. tags: - Resource Group source: openapi/benchling-label-templates-api-openapi.yml - term: LabelTemplate definition: A `LabelTemplate` defines the format for printing physical labels for inventory items, such as containers, plates, and boxes. tags: - Resource Group source: openapi/benchling-labeltemplate-api-openapi.yml - term: Legacy Requests definition: Legacy Requests allow scientists and teams to collaborate around experimental assays and workflows. tags: - Resource Group source: openapi/benchling-legacy-requests-api-openapi.yml