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 Scratch File API

A ScratchFile represents raw file content used as intermediate input or output ofpipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surfacedin the Data Catalog because they typically represent transient processing artifactsrather than standalone valuable data. ScratchFiles track upload state via uploadStatusand provide uploadUrl/downloadUrl for content transfer. When a ScratchFile ispromoted to user-visible status, it is linked to a File object that appears in theData Catalog. The originPipelineStepData field tracks which pipeline step producedthis file.

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

Tagged areas include ScratchFile. 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 13 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 13 schemas 2 GET3 PATCH4 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 Scratch File 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 — 2 GET, 3 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

ScratchFile 9

A ScratchFile represents raw file content used as intermediate input or output of pipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surfaced in the Data Cat…

POST
/scratch-file
Create ScratchFile
ScratchFile.Create 1 param body → 201400403404429500
GET
/scratch-file/items
List ScratchFile items
ScratchFile.List 17 params → 200400403404429500
GET
/scratch-file/{scratch_file_id}
Get ScratchFile by ID
ScratchFile.Get 4 params → 200400403404429500
PATCH
/scratch-file/{scratch_file_id}
Update ScratchFile
ScratchFile.Update 2 params body → 200400403404429500
POST
/scratch-file:batch-create
Batch create ScratchFile
ScratchFile.BatchCreate 1 param body → 201400403404429500
PATCH
/scratch-file:batch-update
Batch update ScratchFile
ScratchFile.BatchUpdate 1 param body → 200400403404429500
POST
/scratch-file:bulk-create
Bulk create ScratchFile
ScratchFile.BulkCreate 1 param body → 202400403404429500
PATCH
/scratch-file:bulk-update
Bulk update ScratchFile
ScratchFile.BulkUpdate 1 param body → 202400403404429500
POST
/scratch-file:create-and-upload
Create a ScratchFile from either uploaded contents or an existing S3 location. Provide exactly one of contents (with a filename, up to 10 MiB of UTF-8 sent as an application/json body) or s3Location…
ScratchFile.CreateAndUpload 1 param body → 200400403404429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ScratchFile (16 properties), InternalServerError (6 properties), GeneralError (5 properties), UpdateScratchFileInputWithPathParams (3 properties). Each schema is shown below with its type and property counts.

UpdateScratchFileInput
object
2 properties 1 required
CreateAndUploadScratchFileInput
object
3 properties
InternalServerError
object
6 properties 5 required
AsyncTaskLink
object
2 properties
ScratchFilePaginatedList
object
2 properties
BulkImport
object
1 property 1 required
ScratchFile
object
A ScratchFile represents raw file content used as intermediate input or output of pipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surf…
16 properties
CreateScratchFileInput
object
2 properties 1 required
PrincipalRef
object
2 properties
FileRef
object
2 properties
PipelineStepDataRef
object
2 properties
UpdateScratchFileInputWithPathParams
object
3 properties 2 required
GeneralError
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-scratchfile-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 Scratch File 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.