# Benchling Scratch File API

**Canonical:** https://apis.io/apis/benchling/benchling-scratchfile-api/  
**Provider:** Benchling — https://apis.io/providers/benchling/  
**Base URL:** https://{tenant}.benchling.com/api/v2  
**Documentation:** https://docs.benchling.com/docs/developer-platform-overview

Benchling Scratch File API is one of 203 APIs that [Benchling](https://apis.io/providers/benchling/) publishes on the [APIs.io](https://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.

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 Catalog because they typically represent transient processing artifacts rather than standalone valuable data. ScratchFiles track upload state via uploadStatus and provide uploadUrl/downloadUrl for content transfer. When a ScratchFile is promoted to user-visible status, it is linked to a File object that appears in the Data Catalog. The originPipelineStepData field tracks which pipeline step produced this file.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| POST | `/scratch-file` | Create ScratchFile |
| GET | `/scratch-file/items` | List ScratchFile items |
| GET | `/scratch-file/{scratch_file_id}` | Get ScratchFile by ID |
| PATCH | `/scratch-file/{scratch_file_id}` | Update ScratchFile |
| POST | `/scratch-file:batch-create` | Batch create ScratchFile |
| PATCH | `/scratch-file:batch-update` | Batch update ScratchFile |
| POST | `/scratch-file:bulk-create` | Bulk create ScratchFile |
| PATCH | `/scratch-file:bulk-update` | Bulk update ScratchFile |
| 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 se... |

## Machine-readable artifacts (15)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/openapi/benchling-scratchfile-api-openapi.yml
- **OpenAPIRemote** — https://benchling.com/api/v3/openapi.yaml
- **Documentation** — https://docs.benchling.com/docs/developer-platform-overview
- **APIReference** — https://benchling.com/api/v3/reference
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/authentication/benchling-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/scopes/benchling-scopes.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/conventions/benchling-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/errors/benchling-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/data-model/benchling-data-model.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/asyncapi/benchling-webhooks.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/rate-limits/benchling-rate-limits.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/lifecycle/benchling-lifecycle.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/changelog/benchling-changelog.yml
- **StabilityPolicy** — https://docs.benchling.com/docs/stability-guidelines
- **SDKs** — https://raw.githubusercontent.com/api-evangelist/benchling/refs/heads/main/packages/benchling-packages.yml

## Other Benchling APIs (12)

- [Benchling AA Sequences API](https://apis.io/apis/benchling/benchling-aa-sequences-api/)
- [Benchling Apps API](https://apis.io/apis/benchling/benchling-apps-api/)
- [Benchling Assay Results API](https://apis.io/apis/benchling/benchling-assay-results-api/)
- [Benchling Assay Runs API](https://apis.io/apis/benchling/benchling-assay-runs-api/)
- [Benchling Audit API](https://apis.io/apis/benchling/benchling-audit-api/)
- [Benchling Authentication API](https://apis.io/apis/benchling/benchling-authentication-api/)
- [Benchling Blobs API](https://apis.io/apis/benchling/benchling-blobs-api/)
- [Benchling Boxes API](https://apis.io/apis/benchling/benchling-boxes-api/)
- [Benchling Codon Usage Tables API](https://apis.io/apis/benchling/benchling-codon-usage-tables-api/)
- [Benchling Connect API](https://apis.io/apis/benchling/benchling-connect-api/)
- [Benchling Containers API](https://apis.io/apis/benchling/benchling-containers-api/)
- [Benchling Custom Entities API](https://apis.io/apis/benchling/benchling-custom-entities-api/)

## Tags

ScratchFile

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/benchling/benchling-scratchfile-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/benchling/.