How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchling Study API

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 current phase determines what modifications are permitted on the study and its associated data.

Benchling Study API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Study. 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 9 operations across 8 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, /api/v3.

9 operations 8 paths 60 schemas 3 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{tenant}.benchling.com/api/v2
Authentication
HTTP Basic, HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

Benchling Study API 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 API
  • basicClientIdSecretAuth — 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 9

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

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
Study.Create body → 201400403404429500
GET
/study/items
List Study items
Study.List 18 params → 200400403404429500
GET
/study/{study_id}
Get Study by ID
Study.Get 3 params → 200400403404429500
PATCH
/study/{study_id}
Update Study
Study.Update 1 param body → 200400403404429500
GET
/study/{study_id}/authors/items
List Principal items
Study.authors.List 2 params → 200400403404429500
POST
/study:batch-create
Batch create Study
Study.BatchCreate body → 201400403404429500
PATCH
/study:batch-update
Batch update Study
Study.BatchUpdate body → 200400403404429500
POST
/study:bulk-create
Bulk create Study
Study.BulkCreate body → 202400403404429500
PATCH
/study:bulk-update
Bulk update Study
Study.BulkUpdate body → 202400403404429500

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are Study (19 properties), LegacyAppInstallation (17 properties), UpdateStudyInputWithPathParams (11 properties), UpdateStudyInput (10 properties). Each schema is shown below with its type and property counts.

UpdateStudyInput
object
10 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
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
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
AppConfigWorkflowTaskSchemaOutput
object
Defines the output field structure for a workflow task schema configuration.
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
DateTimeValue
object
A type that represents datetime values.
2 properties
FolderRef
object
2 properties
FloatAppConfigSpec
object
Specifies that an app configuration field should accept a floating-point number.
3 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
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
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
JsonValue
object
A type that represents JSON values.
2 properties
TextAndUrlValue
object
A type that represents text (string) values with an associated URL.
3 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
JsonAppConfigSpec
object
Specifies that an app configuration field should accept a JSON value.
2 properties
AnyType
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
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
InternalServerError
object
6 properties 5 required
DecimalValue
object
A type that represents decimal value as strings.
3 properties
BooleanAppConfigSpec
object
Specifies that an app configuration field should accept a boolean value.
2 properties
PrincipalRef
object
2 properties
TextAppConfigSpec
object
Specifies that an app configuration field should accept a text string.
3 properties
UpdateStudyInputWithPathParams
object
11 properties 1 required
SchemaFieldDefinitionRef
object
2 properties
CreateStudyInput
object
10 properties 2 required
ObjectLinkListValue
object
A type that represents a list of links to other objects.
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
DateAppConfigSpec
object
Specifies that an app configuration field should accept a date value.
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
DateValue
object
A type that represents date values.
2 properties
DropdownAppConfigSpec
object
Specifies that an app configuration field should be a dropdown with predefined options.
3 properties
ArrayAppConfigSpec
object
Specifies that an app configuration field should accept an array of values.
5 properties
BooleanValue
object
A type that represents boolean values.
2 properties
PrincipalUnpaginatedList
object
1 property
AssayRunFeatureSpec
object
Defines an assay run feature for a Benchling App, allowing the app to process or generate lab automation run data.
3 properties
UpdateFieldValueInput
object
2 properties 2 required
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
Principal
object
BulkImport
object
1 property 1 required
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
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
StudySchemaRef
object
2 properties
IntegerValue
object
A type that represents integer values.
2 properties
GeneralError
object
5 properties 5 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
FieldValueInput
object
1 property 1 required
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
AsyncTaskLink
object
2 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
IntegerAppConfigSpec
object
Specifies that an app configuration field should accept an integer value.
3 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
StudyPaginatedList
object
2 properties
AppConfigDropdownOption
object
Defines an option within a dropdown-type app configuration field.
4 properties
ObjectRef
object
2 properties
EntryRef
object
2 properties
TextValue
object
A type that represents text (string) values.
2 properties
DateTimeAppConfigSpec
object
Specifies that an app configuration field should accept a datetime value.
2 properties
SecureTextAppConfigSpec
object
Specifies that an app configuration field should accept secure (encrypted) text. Used for sensitive data like API keys or credentials.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-study-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Benchling Study API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.