Create and upload a ScratchFile

Beta

POST

https://{tenant_name}.benchling.com/api/v3/scratch-file:create-and-upload

POST

/api/v3/scratch-file:create-and-upload

curl -X POST https://{tenant_name}.benchling.com/api/v3/scratch-file:create-and-upload \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "__typename": "__typename",
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "downloadUrl": "downloadUrl",
  "errorMessage": "errorMessage",
  "externalFileId": "externalFileId",
  "file": {
    "__typename": "__typename",
    "id": "id"
  },
  "filename": "filename",
  "id": "id",
  "mimeType": "mimeType",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "originAutomationStepData": {
    "__typename": "__typename",
    "id": "id"
  },
  "size": 1,
  "uploadStatus": "SUCCEEDED",
  "uploadUrl": "uploadUrl",
  "originPipelineStepData": {
    "__typename": "__typename",
    "id": "id"
  }
}

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 (the filename is derived from the location when omitted).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

contentsstringOptional

filenamestringOptional

s3LocationstringOptional

Response

__typenamestringOptional

createdAtstring or nullOptional

creatorobjectOptional

downloadUrlstring or nullOptional

errorMessagestring or nullOptional

externalFileIdstring or nullOptional

fileobject or nullOptional

filenamestringOptional

idstringOptional

mimeTypestring or nullOptional

modifiedAtstring or nullOptional

namestringOptional

originAutomationStepDataobject or nullOptional

The automation step data that produced this file.

sizeinteger or nullOptional

uploadStatusenumOptional

Allowed values:

uploadUrlstring or nullOptional

originPipelineStepDataobject or nullOptionalDeprecated

Use originAutomationStepData instead.

Errors

400

Scratch File Create and Upload Request Bad Request Error

403

Scratch File Create and Upload Request Forbidden Error

404

Scratch File Create and Upload Request Not Found Error

409

Scratch File Create and Upload Request Conflict Error

429

Scratch File Create and Upload Request Too Many Requests Error

500

Scratch File Create and Upload Request Internal Server Error

Authentication

Headers

Request

Response

Errors