BEbenchling
dataFrames

Create a data frame.

Create a data frame.

Data frames can be created from .csv files, and only 1 .csv file can currently be uploaded.

A successful data frame upload requires 3 calls in serial:

  1. Create a data frame, this endpoint, specifying the files to upload. This returns a manifest containing S3 PUT URLs corresponding to the files that will be uploaded for the 2nd call and a data frame ID for the 3rd call.
  2. Upload the data frame .csv content to S3. Add x-amz-server-side-encryption: AES256 to the request headers, because we use server-side encryption. Here is a curl example: 
    curl -H "x-amz-server-side-encryption: AES256" -X PUT -T <LOCAL_FILE> -L <S3_PUT_URL>
  3. Update the data frame to mark as IN_PROGRESS to start a long-running task to process and validate the data frame.
    • For more details on how we process and validate data frames, click here.

Note: Manifest URLs are valid for 1 hour after being returned from this endpoint. They should not be stored persistently for later use.

CSV files up to 150MB are supported.

post/data-frames

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Request body

namestring required

Response

OK

errorMessagestring nullable
uploadStatus'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED_VALIDATION' | 'NOT_UPLOADED'
idstring
namestring

The user-facing name for this DataFrame.

Changes

No recorded changes to this operation across all 1 revision of this API.