Start multipart upload session

Start a multipart upload session. Use this endpoint when you need to upload a file larger than 10 MB to a batch.

The multipart upload process consists of three steps:

Create a multipart upload session (this endpoint)
Upload file parts to the session
Commit the session to finalize the upload

Start a multipart upload session. Use this endpoint when you need to upload a file larger than 10 MB to a batch. The multipart upload process consists of three steps: 1. Create a multipart upload session (this endpoint) 2. [Upload file parts](/api-sdk/api-reference/batches/upload-multipart-part) to the session 3. [Commit the session](/api-sdk/api-reference/batches/commit-multipart-upload-session) to finalize the upload

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Request

This endpoint expects an object.

batch_idintegerRequired

The batch ID to upload the file to.

filenamestringRequired

A file name for the uploaded file on the AI Hub filesystem, including the file extension. Maximum of 255 characters.

file_sizeintegerRequired

The file size, in bytes. Can be an integer or a string.

Response headers

Locationstring

The session endpoint URL to use in subsequent multipart upload requests, in the form <API-ROOT>/v2/batches/multipart-upload/sessions/<SESSION-ID>.

Response

The multipart upload session was initiated.

session_idstring

ID of the multipart upload session.

part_sizeinteger

The number of bytes each part should be when uploading to the session. Each part should match the part_size, except for the final part, which can be smaller than the part_size.

Errors

404

Not Found Error

$	curl "${API_ROOT}/v2/batches/multipart-upload" \
>	-H "Authorization: Bearer ${API_TOKEN}" \
>	-H "IB-Context: ${IB_CONTEXT}" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"batch_id": <BATCH-ID>,
>	"filename": "large-file.pdf",
>	"file_size": 15728640
>	}'

Authentication

Headers

Request

Response headers

Response

Errors

Authentication

Headers

Request

Response headers

Response

Errors

1	{
2	"session_id": "yGLRzUtS2vHm9IdxMrsKaMEOXG7hGBU7KEuvm2JujgBuO9ZAwtqTYmAYauf1RHI8bgEq7qm_UnCE5YNdMg7.1Lv_lrKRVPQ4fZpNVgF3wD5dbvz_bgbmx50a2.kcDZN7XjOI1z.NQ8_9JfOLhtYIgA6xMGLv5U0p6FitSDtFgW4-",
3	"part_size": 10485760
4	}