---
title: "Batch create DataFrame"
method: POST
path: "/api/v3/data-frame:batch-create"
tags: ["Data Frame"]
---

# Batch create DataFrame

`POST /api/v3/data-frame:batch-create`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/data-frame:batch-create`
- Auth: HTTP bearer

Batch create DataFrame synchronously in one transaction. Maximum 20 items per request.

## Request body

- object
  - `items` CreateDataFrameInput[], required
    - `delimiter` string: Single-character delimiter used when parsing the file. Defaults to a tab for .tsv files and ',' otherwise.
    - `locale` string: Locale used for number parsing, such as decimal and thousands separators (e.g. 'en-US'). Defaults to 'en-US' if not specified.
    - `name` string, required
    - `scratchFileId` string, nullable, required: ID of ScratchFile containing the raw file from which to create the DataFrame. Only files with a .csv or .tsv extension are supported.

## Response `201`

Created

- DataFrameBatchcreateResponse201
  - `items` DataFrame[], required
    - `__typename` string
    - `columns` DataFrameColumn[]
      - `__typename` string
      - `displayName` string
      - `systemName` string
      - `type` DataFrameColumnType
    - `createdAt` string, datetime
    - `creator` PrincipalRef
      - `__typename` string
      - `id` string, api_id
    - `dataset` DatasetRef
      - `__typename` string
      - `id` string, api_id
    - `errorMessage` string, nullable
    - `id` string
    - `manifest` DataFrameManifestItem[]
      - `__typename` string
      - `fileName` string
      - `url` string
    - `modifiedAt` string, datetime
    - `name` string
    - `size` integer
    - `uploadStatus` 'SUCCEEDED' | 'FAILED_VALIDATION' | 'IN_PROGRESS' | 'NOT_UPLOADED'

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)