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 Entries API

Entries are rich text documents that allow you to capture all of your experimental data in one place.

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

Tagged areas include Entries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and a status page.

This API exposes 11 operations across 8 paths, and defines 56 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

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

11 operations 8 paths 56 schemas 6 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
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 Entries 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 11

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

Entries 11

Entries are rich text documents that allow you to capture all of your experimental data in one place.

GET
/entries
List entries
listEntries 19 params → 200400
POST
/entries
Create a notebook entry
createEntry body → 201400
GET
/entries/{entry_id}
Get a notebook entry by ID
getEntry 2 params → 200404
PATCH
/entries/{entry_id}
Update a notebook entry's metadata
updateEntry 2 params body → 200
GET
/entries/{entry_id}/external-files/{external_file_id}
Retrieves the metadata for an external file. Use the 'downloadURL' to download the actual file.
getExternalFileMetadata 2 params → 200
POST
/entries:archive
Archive notebook entries
archiveEntries body → 200
GET
/entries:bulk-get
Get notebook entries using entry IDs or display IDs
bulkGetEntries 3 params → 200400
POST
/entries:unarchive
Unarchive notebook entries
unarchiveEntries body → 200
GET
/entry-templates
List entry templates
listEntryTemplates 8 params → 200400
GET
/entry-templates/{entry_template_id}
Get a notebook template entry by ID
getEntryTemplate 2 params → 200
PATCH
/entry-templates/{entry_template_id}
Update a notebook template entry's metadata
updateEntryTemplate 2 params body → 200

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are Entry (18 properties), EntryTemplate (12 properties), EntryCreate (8 properties), ReviewChange (6 properties). Each schema is shown below with its type and property counts.

ReviewSnapshot
object
5 properties
InventoryPlateTableNotePart
SimpleNotePart
Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'listbullet': one "line" of a bulleted list - 'listnumb…
EntriesArchive
object
2 properties 2 required
ReviewChange
object
6 properties
Fields
object
MixturePrepTableNotePart
StructuredTableApiIdentifiers
object
3 properties
EntryTableCell
object
2 properties
EntryTemplateUpdate
object
5 properties
EntryNotePart
object
Notes are the main building blocks of entries. Each note corresponds roughly to a paragraph.
CustomField
object
1 property
ResultsTableNotePart
BadRequestError
object
1 property
TextBoxNotePart
ChartNotePart
RegistrationTableNotePart
BaseError
object
3 properties
ArchiveRecord
object
1 property
PlateCreationTableNotePart
EntriesArchivalChange
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of entries that changed..
1 property
EntryById
object
1 property
FieldType
string
Entry
object
Entries are notes that users can take. They're organized by "days" (which are user-configurable) and modeled within each day as a list of "notes." Each note ha…
18 properties
EntryTemplateDay
object
3 properties
UserSummary
ExternalFileNotePart
An attached user-uploaded file
EntryTableRow
object
Each has property 'cells' that is an array of cell objects
1 property
Field
object
5 properties 1 required
EntryReviewProcess
object
5 properties
PartySummary
object
3 properties
EntryLink
object
Links are contained within notes to reference resources that live outside of the entry. A link can target an external resource via an http(s):// hyperlink or a…
3 properties
EntryDay
object
3 properties
EntryTemplatesPaginatedList
object
2 properties
EntryUpdate
object
5 properties
CustomFields
object
AppCanvasNotePart
EntryExternalFile
object
The ExternalFile resource stores metadata about the file. The actual original file can be downloaded by using the 'downloadURL' property.
4 properties
NotFoundError
object
1 property
EntrySchema
object
Entry schema
3 properties
EntryTable
object
Actual tabular data with rows and columns of text on the note.
3 properties
BoxCreationTableNotePart
BaseNotePart
object
2 properties
AssayRunNotePart
EntryTemplate
object
Entry templates are templates that users can base new notebook entries off of.
12 properties
CheckboxNotePart
One "line" of a checklist
InitialTable
object
2 properties
EntryExternalFileById
object
1 property
EntryCreate
object
8 properties 2 required
EntriesUnarchive
object
1 property 1 required
EntriesPaginatedList
object
2 properties
InventoryContainerTableNotePart
StructuredTableColumnInfo
object
3 properties
TableNotePart
A table with rows and columns of text
Entries
object
1 property
LookupTableNotePart

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-entries-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 Entries 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.