API referenceBatches

Create batch

Create a new batch. <Note>[Upload files to the batch](/api-sdk/api-reference/batches/add-file-to-batch) in a separate request.</Note>

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Headers

IB-ContextstringOptional

Typically your organization ID. See Authorization and context identification for details.

Request

This endpoint expects an object.
namestringRequired
Name of the batch. Maximum length is 255 characters.
workspacestringOptional
The name of the workspace in which to add the batch. If not specified, the default location is your personal workspace. When making this call from a service account, you must specify a workspace. <Info>For organization members, if the default drive changes but is still connected, you can still use the batch as input for running an app. However, you can't upload any additional files to the batch. If the default drive is disconnected, you can't use batches stored on that drive as input for any app run.</Info>

Response

Batch created successfully.
idinteger
Unique identifier for the batch.