components:
parameters:
action.anyOf:
description: Restricts results to audit logs matching any of the specified action
display names (e.g. 'Updated name', 'Created'). Comma-separated list.
explode: false
in: query
name: action.anyOf
schema:
items:
type: string
maxItems: 100
type: array
aminoAcids.anyOf:
description: Restricts results to those whose sequence exactly matches any of
the specified amino acid sequences (case-insensitive). Comma-separated list.
explode: false
in: query
name: aminoAcids.anyOf
schema:
items:
type: string
maxItems: 100
type: array
archiveReason.anyOf:
description: Restricts items to those with any of the specified archive reasons.
Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter
for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED"
to return items for both archived and unarchived. Comma-separated list.
explode: false
in: query
name: archiveReason.anyOf
schema:
items:
type: string
maxItems: 10
type: array
archived.anyOf:
description: If true, returns archived items. If false, returns unarchived items.
If both true and false, returns archived and unarchived items. Comma-separated
list.
explode: false
in: query
name: archived.anyOf
schema:
items:
type: boolean
maxItems: 2
type: array
authors.anyOf:
description: Restricts results to those whose author matches any of the specified
user or author IDs. Comma-separated list.
explode: false
in: query
name: authors.anyOf
schema:
items:
type: string
maxItems: 100
type: array
barcode.anyOf:
description: Restricts results to those matching any of the specified barcodes.
Fails and reports any invalid barcodes. Comma-separated list.
explode: false
in: query
name: barcode.anyOf
schema:
items:
type: string
maxItems: 100
type: array
bases.anyOf:
description: Restricts results to those whose sequence exactly matches any of
the specified DNA base sequences (case-insensitive, accounting for circular
and reverse complement). Comma-separated list.
explode: false
in: query
name: bases.anyOf
schema:
items:
type: string
maxItems: 100
type: array
collaboratorId.anyOf:
description: Restricts results to collaborations for any of the specified collaborator
IDs. Comma-separated list.
explode: false
in: query
name: collaboratorId.anyOf
schema:
items:
type: string
maxItems: 100
type: array
createdAt.gt:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those created after the specified time. e.g. > 2017-04-30.
in: query
name: createdAt.gt
schema:
format: datetime
type: string
createdAt.gte:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those created at or after the specified time. e.g. >= 2017-04-30.
in: query
name: createdAt.gte
schema:
format: datetime
type: string
createdAt.lt:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those created before the specified time. e.g. < 2017-04-30.
in: query
name: createdAt.lt
schema:
format: datetime
type: string
createdAt.lte:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those created at or before the specified time. e.g. <= 2017-04-30.
in: query
name: createdAt.lte
schema:
format: datetime
type: string
creator.anyOf:
description: Restricts results to those created by any of the specified user
IDs. Comma-separated list.
explode: false
in: query
name: creator.anyOf
schema:
items:
type: string
maxItems: 100
type: array
entry.anyOf:
description: Restricts results to those in entries matching any of the specified
entry IDs. Comma-separated list.
explode: false
in: query
name: entry.anyOf
schema:
items:
type: string
maxItems: 100
type: array
entry.eq:
description: Single entry ID. Restricts results to those in the specified entry.
in: query
name: entry.eq
schema:
type: string
featureLibrary.eq:
description: ID of a Feature Library.
in: query
name: featureLibrary.eq
schema:
type: string
fieldset.anyOf:
description: Restricts results to those whose schema implements any of the specified
fieldset API IDs (custom schema interfaces). Comma-separated list.
explode: false
in: query
name: fieldset.anyOf
schema:
items:
type: string
maxItems: 100
type: array
groupId.eq:
description: Restricts results to memberships of the specified group ID.
in: query
name: groupId.eq
schema:
type: string
id.anyOf:
description: Restricts results to those matching any of the specified IDs. Comma-separated
list.
explode: false
in: query
name: id.anyOf
schema:
items:
type: string
maxItems: 100
type: array
item.anyOf:
description: Restricts results to only those associated with any of the specified
item IDs. Comma-separated list.
explode: false
in: query
name: item.anyOf
schema:
items:
type: string
maxItems: 100
type: array
libraryParameterDefinition.anyOf:
description: Restricts results to parameter versions linked to any of the specified
library parameter definition IDs. Comma-separated list.
explode: false
in: query
name: libraryParameterDefinition.anyOf
schema:
items:
type: string
maxItems: 100
type: array
memberId.eq:
description: Restricts results to memberships for the specified member (principal)
ID.
in: query
name: memberId.eq
schema:
type: string
mentionedIn.anyOf:
description: Restricts results to items mentioned in entries matching any of
the specified entry IDs. Comma-separated list.
explode: false
in: query
name: mentionedIn.anyOf
schema:
items:
type: string
maxItems: 100
type: array
methodExecutionInstance.anyOf:
description: Restricts results to only those that are part of procedure method
execution instances matching any of the specified procedure method execution
instance IDs. Comma-separated list.
explode: false
in: query
name: methodExecutionInstance.anyOf
schema:
items:
type: string
maxItems: 100
type: array
model.anyOf:
description: Restricts results to prediction batches using any of the specified
model names. Comma-separated list.
explode: false
in: query
name: model.anyOf
schema:
items:
type: string
maxItems: 100
type: array
modifiedAt.gt:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those modified after the specified time. e.g. > 2017-04-30.
in: query
name: modifiedAt.gt
schema:
format: datetime
type: string
modifiedAt.gte:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those modified at or after the specified time. e.g. >= 2017-04-30.
in: query
name: modifiedAt.gte
schema:
format: datetime
type: string
modifiedAt.lt:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those modified before the specified time. e.g. < 2017-04-30.
in: query
name: modifiedAt.lt
schema:
format: datetime
type: string
modifiedAt.lte:
description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts
results to those modified at or before the specified time. e.g. <= 2017-04-30.
in: query
name: modifiedAt.lte
schema:
format: datetime
type: string
name.anyOf:
description: Restricts results to those that match any of the specified names.
Case insensitive. Warning - this filter can be non-performant due to case
insensitivity. Ensure only one name filter is used at a time. Comma-separated
list.
explode: false
in: query
name: name.anyOf
schema:
items:
type: string
maxItems: 100
type: array
name.anyOf.caseSensitive:
description: Restricts results to those that match any of the specified names.
Case sensitive. Ensure only one name filter is used at a time. Comma-separated
list.
explode: false
in: query
name: name.anyOf.caseSensitive
schema:
items:
type: string
maxItems: 100
type: array
nextToken:
description: Token for pagination
in: query
name: nextToken
schema:
type: string
objectId.anyOf:
description: Retrieves audit logs for the specified object API IDs. Comma-separated
list.
explode: false
in: query
name: objectId.anyOf
schema:
items:
type: string
maxItems: 10
type: array
omit:
description: Comma-separated list of top-level fields to omit from each returned
item. Cannot overlap with returning.
explode: false
in: query
name: omit
schema:
items:
type: string
type: array
pageSize:
description: Number of results to return. Defaults to 50, maximum of 100.
in: query
name: pageSize
schema:
type: integer
parameterVersion.anyOf:
description: Restricts results to those that are children of procedure parameter
versions matching any of the specified procedure parameter version IDs. Comma-separated
list.
explode: false
in: query
name: parameterVersion.anyOf
schema:
items:
type: string
maxItems: 100
type: array
parent.eq:
description: ID of a folder. Restricts results to its direct children.
in: query
name: parent.eq
schema:
type: string
parentStorage.eq:
description: ID of a location. Restricts results to those located in the specified
inventory.
in: query
name: parentStorage.eq
schema:
type: string
predictionBatch.eq:
description: ID of a Prediction Batch. Returns prediction jobs belonging to
the specified batch.
in: query
name: predictionBatch.eq
schema:
type: string
procedureParameter.eq:
description: ID of a procedure parameter. Restricts results to children of the
specified parameter.
in: query
name: procedureParameter.eq
schema:
type: string
procedureRun.eq:
description: ID of a procedure run. Restricts results to only those that are
part of the specified procedure run.
in: query
name: procedureRun.eq
schema:
type: string
procedureRunCondition.eq:
description: ID of a procedure run condition. Restricts results to only those
that are part of the specified procedure run condition.
in: query
name: procedureRunCondition.eq
schema:
type: string
procedureRunConditionReplicate.anyOf:
description: Restricts results to only those that are part of procedure run
condition-replicates matching any of the specified procedure run condition-replicate
IDs. Comma-separated list.
explode: false
in: query
name: procedureRunConditionReplicate.anyOf
schema:
items:
type: string
maxItems: 100
type: array
project.eq:
description: ID of a project. Restricts results to those in the project.
in: query
name: project.eq
schema:
type: string
reasonCode.anyOf:
description: Restricts results to audit logs with any of the specified reason
codes. Comma-separated list.
explode: false
in: query
name: reasonCode.anyOf
schema:
items:
type: string
maxItems: 100
type: array
registry.eq:
description: ID of a registry. Restricts results to those registered in this
registry. Specifying "null" returns unregistered items.
in: query
name: registry.eq
schema:
type: string
resourceId.anyOf:
description: Restricts results to collaborations on any of the specified resource
IDs. Comma-separated list.
explode: false
in: query
name: resourceId.anyOf
schema:
items:
type: string
maxItems: 100
type: array
returning:
description: Comma-separated list of top-level fields to include in each returned
item. Cannot overlap with omit.
explode: false
in: query
name: returning
schema:
items:
type: string
type: array
review.eq:
description: ID of a Review.
in: query
name: review.eq
schema:
type: string
reviewId.anyOf:
description: Restricts results to review changes for any of the specified Review
API IDs. Comma-separated list.
explode: false
in: query
name: reviewId.anyOf
schema:
items:
type: string
maxItems: 100
type: array
reviewProcess.eq:
description: ID of a ReviewProcess.
in: query
name: reviewProcess.eq
schema:
type: string
reviewableId.anyOf:
description: Restricts results to review changes for items with any of the specified
reviewable item IDs (e.g. entry IDs like etr_...). Comma-separated list.
explode: false
in: query
name: reviewableId.anyOf
schema:
items:
type: string
maxItems: 100
type: array
schema.anyOf:
description: Restricts results to those that match any of the specified schema
IDs. Use only one `schema` filter arg at a time. Comma-separated list.
explode: false
in: query
name: schema.anyOf
schema:
items:
type: string
maxItems: 100
type: array
schema.eq:
description: Single schema ID. Restricts results to those that match the specified
schema exactly. Use only one `schema` filter arg at a time.
in: query
name: schema.eq
schema:
type: string
sequenceIds.anyOf:
description: Restricts results to Nucleotide Alignments owned by any of the
specified sequence IDs (i.e. sequences used as the template in a Template
Alignment or created as the consensus sequence from a Consensus Alignment).
Fails and reports any invalid IDs. Comma-separated list.
explode: false
in: query
name: sequenceIds.anyOf
schema:
items:
type: string
maxItems: 100
type: array
study.anyOf:
description: Restricts results to those associated with any of the specified
study IDs. Comma-separated list.
explode: false
in: query
name: study.anyOf
schema:
items:
type: string
maxItems: 100
type: array
study.eq:
description: ID of a study. Restricts results to only those that are part of
the specified study.
in: query
name: study.eq
schema:
type: string
systemCategory.anyOf:
description: Restricts results to those whose schema implements any of the specified
system category API IDs (non-exclusive static schema interfaces). Comma-separated
list.
explode: false
in: query
name: systemCategory.anyOf
schema:
items:
type: string
maxItems: 100
type: array
templateProcedureFlowchartVersion.anyOf:
description: Restricts results to only those created from template procedure
flowchart versions matching any of the specified template procedure flowchart
version IDs. Comma-separated list.
explode: false
in: query
name: templateProcedureFlowchartVersion.anyOf
schema:
items:
type: string
maxItems: 100
type: array
templateProcedureMethodVersion.eq:
description: ID of a procedure method definition version. Restricts results
to only those that have the specified template procedure method version.
in: query
name: templateProcedureMethodVersion.eq
schema:
type: string
userId.anyOf:
description: Restricts results to those associated with any of the specified
user API IDs. Comma-separated list.
explode: false
in: query
name: userId.anyOf
schema:
items:
type: string
maxItems: 100
type: array
worksheet.anyOf:
description: Restricts results to only those executed in worksheets matching
any of the specified worksheet IDs. Comma-separated list.
explode: false
in: query
name: worksheet.anyOf
schema:
items:
type: string
maxItems: 100
type: array
responses:
BadRequest:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GeneralError'
description: Bad Request
Conflict:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GeneralError'
description: Conflict
Forbidden:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GeneralError'
description: Forbidden
InternalServerError:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/InternalServerError'
description: Internal Server Error
NotFound:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GeneralError'
description: Not Found
PaymentRequired:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GeneralError'
description: Payment Required
TooManyRequests:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GeneralError'
description: Too Many Requests
schemas:
AaAnnotation:
description: 'Represents an annotated region on an amino acid sequence (AaSequence).
Annotations mark
functional domains, binding sites, post-translational modifications, engineered
mutations,
or other biologically significant features. Each annotation defines a start
and end
position (0-based, exclusive end), a name, optional type classification, display
color,
and descriptive notes. Annotations appear as visual overlays on the sequence
viewer.'
properties:
__typename:
type: string
aaSequence:
$ref: '#/components/schemas/AaSequenceRef'
description: AA sequence the annotation belongs to.
color:
description: Hex color when displaying the annotation.
type: string
end:
description: 0-based exclusive end index.
type: integer
id:
description: ID of the annotation.
type: string
name:
description: Name of the annotation.
type: string
notes:
description: Text notes on the annotation.
type: string
start:
description: 0-based inclusive start index.
type: integer
type:
description: Feature type of the annotation.
type:
- 'null'
- string
type: object
AaAnnotationInput:
additionalProperties: false
properties:
color:
type: string
end:
type: integer
name:
type: string
notes:
type: string
start:
type: integer
type:
type: string
required:
- name
- end
- start
type: object
AaAnnotationInputUpdate:
additionalProperties: false
properties:
annotationId:
type: string
color:
type: string
end:
type: integer
name:
type: string
notes:
type: string
start:
type: integer
type:
type: string
required:
- name
- end
- start
type: object
AaChainConfigurationInput:
additionalProperties: false
properties:
systemCategoryId:
enum:
- ssi_aachain
type: string
required:
- systemCategoryId
type: object
AaDomainConfigurationInput:
additionalProperties: false
properties:
systemCategoryId:
enum:
- ssi_aadomain
type: string
required:
- systemCategoryId
type: object
AaPairConfigurationInput:
additionalProperties: false
properties:
systemCategoryId:
enum:
- ssi_aapair
type: string
required:
- systemCategoryId
type: object
AaPartLinkFieldDefinition:
description: A schema field definition for linking to AA parts.
properties:
__typename:
type: string
archiveReason:
type:
- 'null'
- string
archived:
type: boolean
createdAt:
format: datetime
type:
- 'null'
- string
derivationType:
enum:
- DIRECT
- COMPUTED
- SNAPSHOT
type: string
description:
type:
- 'null'
- string
id:
type: string
isMulti:
type: boolean
isParent:
description: 'Means the link is from a child to a parent AA part. Important
for the registry''s lot-numbering
functionality.'
type: boolean
isRequired:
type: boolean
modifiedAt:
format: datetime
type:
- 'null'
- string
name:
type: string
systemName:
type: string
type: object
AaSequence:
allOf:
- $ref: '#/components/schemas/IAaSequence'
- description: '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
regions, domains, or other
features of interest. `AaSequence`s can be registered in the Registry with
a unique entityRegistryId,
organized in folders, and linked via schema fields to other entities. The
annotations array contains
`AaAnnotation` objects for features like signal peptides, binding domains,
or engineered mutations.
Parts (see `AaPart`) indicate regions matching other registered `AaSequence`s.'
properties:
__typename:
type: string
authors:
oneOf:
- format: uri
type: string
- type: 'null'
creator:
oneOf:
- $ref: '#/components/schemas/PrincipalRef'
- type: 'null'
schemaFields:
oneOf:
- items:
$ref: '#/components/schemas/SchemaFieldValue'
type: array
- type: 'null'
type: object
AaSequenceLinkFieldDefinition:
description: A schema field definition for linking to AA sequences.
properties:
__typename:
type: string
archiveReason:
type:
- 'null'
- string
archived:
type: boolean
createdAt:
format: datetime
type:
- 'null'
- string
derivationType:
enum:
- DIRECT
- COMPUTED
- SNAPSHOT
type: string
description:
type:
- 'null'
- string
id:
type: string
isMulti:
type: boolean
isParent:
description: 'Means the link is from a child to a parent AA sequence. Important
for the registry''s lot-numbering
functionality.'
type: boolean
isRequired:
type: boolean
linkDefinition:
oneOf:
- $ref: '#/components/schemas/AaSequenceSchemaRef'
- type: 'null'
modifiedAt:
format: datetime
type:
- 'null'
- string
name:
type: string
systemName:
type: string
type: object
AaSequencePaginatedList:
additionalProperties: false
properties:
items:
items:
$ref: '#/components/schemas/AaSequence'
type: array
nextToken:
type: string
type: object
AaSequenceRef:
properties:
__typename:
type: string
id:
format: api_id
type: string
type: object
AaSequenceSchema:
description: Defines the structure, field definitions, and configuration options
for AA sequences.
properties:
__typename:
type: string
archiveReason:
type:
- 'null'
- string
archived:
type: boolean
availableRegistrationNamingOptions:
items:
enum:
- NEW_IDS
- IDS_FROM_NAMES
- DELETE_NAMES
- SET_FROM_NAME_PARTS
- REPLACE_NAMES_FROM_PARTS
- KEEP_NAMES
- REPLACE_ID_AND_NAME_FROM_PARTS
type: string
type: array
constraint:
oneOf:
- $ref: '#/components/schemas/Constraint'
- type: 'null'
containableType:
enum:
- NONE
- ENTITY
- BATCH
type: string
containerNameTemplate:
oneOf:
- $ref: '#/components/schemas/ContainerNameTemplate'
- type: 'null'
createdAt:
format: datetime
type:
- 'null'
- string
description:
type: string
fieldDefinitions:
description: "The field definitions configured on this schema. Supported
types include:\n\n- Legacy: `BaseFieldDefinition`, `SchemaLinkFieldDefinition`\n\n-
Primitive: `TextFieldDefinition`, `LongTextFieldDefinition`, `IntegerFieldDefinition`,\n
\ `FloatFieldDefinition`, `BooleanFieldDefinition`, `DateFieldDefinition`,
`DateTimeFieldDefinition`\n\n- Dropdown: `DropdownLinkFieldDefinition`\n\n-
Blob: `BlobLinkFieldDefinition`\n\n- Entity links: `AnyEntityLinkFieldDefinition`,
`CustomEntityLinkFieldDefinition`,\n `AaSequenceLinkFieldDefinition`,
`DnaSequenceLinkFieldDefinition`, `MixtureLinkFieldDefinition`,\n `MoleculeLinkFieldDefinition`,
`AntibodyLinkFieldDefinition`, `OligoConjugateLinkFieldDefinition`,\n
\ `OligoDuplexLinkFieldDefinition`, `DnaOligoLinkFieldDefinition`, `RnaOligoLinkFieldDefinition`\n\n-
Storage: `StorableLinkFieldDefinition`\n\n- Assay links: `AssayRequestLinkFieldDefinition`,
`AssayResultLinkFieldDefinition`,\n `AssayRunLinkFieldDefinition`\n\n-
Part links: `AaPartLinkFieldDefinition`\n\n`JsonFieldDefinition` is not
supported."
format: uri
type: string
fieldsets:
format: uri
type: string
iconId:
enum:
- ANTIBODY
- BASIC_FOLDER_ITEM
- LINEAR
- PROTEIN
type: string
id:
type: string
includeRegistryIdInChips:
type: boolean
itemIdPrefix:
type: string
modifiedAt:
format: datetime
type: string
name:
type: string
nameTemplate:
oneOf:
- $ref: '#/components/schemas/EntityNameTemplate'
- type: 'null'
organization:
$ref: '#/components/schemas/OrganizationRef'
showResidues:
description: Controls whether amino acid residues are displayed in the UI.
type: boolean
systemCategories:
items:
$ref: '#/components/schemas/SystemCategoryConfiguration'
type: array
systemName:
type: string
useRegistryIdForItemDisplayLabel:
type: boolean
type: object
AaSequenceSchemaPaginatedList:
additionalProperties: false
properties:
items:
items:
$ref: '#/components/schemas/AaSequenceSchema'
type: array
nextToken:
type: string
type: object
AaSequenceSchemaRef:
properties:
__typename:
type: string
id:
format: api_id
type: string
type: object
AaSequenceSchemaSetFieldDefinitionsInput:
additionalProperties: false
properties:
fieldDefinitions:
items:
anyOf:
- $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
- $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
- $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
- $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
- $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
- $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
- $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
- $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
- $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
# --- truncated at 32 KB (2606 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/openapi/benchling-v3-openapi.yaml