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

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.

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

Tagged areas include File. 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 6 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

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

6 operations 4 paths 18 schemas 2 GET1 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 Files 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 6

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

Files 6

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…

GET
/files
List files
listFiles 17 params → 200400
POST
/files
Create a file
createFile body → 200400403
GET
/files/{file_id}
Get a file
getFile 1 param → 200403404
PATCH
/files/{file_id}
Update a file
patchFile 1 param body → 200400403404
POST
/files:archive
Archive files
archiveFiles body → 200400
POST
/files:unarchive
Unarchive files.
unarchiveFiles body → 200400

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are FileCreate (4 properties), FileUpdate (4 properties), BaseError (3 properties), PartySummary (3 properties). Each schema is shown below with its type and property counts.

CustomField
object
1 property
BadRequestError
object
1 property
FilesPaginatedList
object
2 properties
ListingError
object
1 property
BaseError
object
3 properties
FilesArchive
object
The request body for archiving Files.
2 properties 2 required
ArchiveRecord
object
1 property
FileCreate
object
4 properties
File
UserSummary
FilesUnarchive
object
The request body for unarchiving Files.
1 property 1 required
ForbiddenError
object
1 property
PartySummary
object
3 properties
FileUpdate
object
4 properties
CustomFields
object
NotFoundError
object
1 property
FilesArchivalChange
object
IDs of all items that were archived or unarchived, grouped by resource type.
1 property
FileStatus
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-files-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 Files 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.