Create ScratchFile

Beta

POST

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

POST

/api/v3/scratch-file

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

{
  "__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 ScratchFile.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

filenamestringRequired

namestringOptional

Response

Created

__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 Request Bad Request Error

403

Scratch File Create Request Forbidden Error

404

Scratch File Create Request Not Found Error

409

Scratch File Create Request Conflict Error

429

Scratch File Create Request Too Many Requests Error

500

Scratch File Create Request Internal Server Error

Authentication

Headers

Request

Response

Errors