Create batch — Instabase Documentation

Create a new batch.

Upload files to the batch in a separate request.

Headers

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. 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; the batch is created in the default drive of the workspace. If not specified, the default location for organization members is the default drive of your personal workspace. For community users, the default location is your personal workspace’s Instabase Drive.

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.

Response

Batch created successfully.

idinteger

Unique identifier for the batch.

1	curl "${API_ROOT}/v2/batches" \
2	-H "Authorization: Bearer ${API_TOKEN}" \
3	-H "IB-Context: ${IB_CONTEXT}"\
4	-H "Content-Type: application/json" \
5	-d '{"name": "test"}'