Chunked Files

Add Chunked File Part

This endpoint is used to append a chunkedFilePart to a chunked file.

Chunked file parts must provide an offset and a size along with content. The first chunked file part must have offset 0. You may add the same chunked file part multiple times to retry a failed import. When retrying, you must use the same offset and size. You may add chunked file parts out of order.

Maximum chunked file part size: 50 MiB.
Maximum number of chunked file parts in one file: 1000.
Maximum overall file size: 20 GiB.

The body of the request is an HTTP form with the Content-Type header set to multipart/form-data, and contains 2 parts: chunkedFilePart for the chunk properties, and fileChunk for the data.

The chunkedFilePart must have the Content-Type header set to application/json and is similar to other entity types. It specifies the offset and size of the chunk.

The fileChunk contains the file to be imported. Its Content-Type header must correspond to the file’s data type.

For example, for a .csv file, the Content-Type header for the fileChunk should be text/csv.

Permissions

api.file-manager.write

POST

chunked-files

{chunkedFileId}

part

Add Chunked File Part

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'chunkedFilePart={
  "offset": 1,
  "size": 1
}' \
  --form fileChunk='@example-file'

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part"

files = { "fileChunk": ("example-file", open("example-file", "rb")) }
payload = { "chunkedFilePart": "{
  \"offset\": 1,
  \"size\": 1
}" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('chunkedFilePart', '{
  "offset": 1,
  "size": 1
}');
form.append('fileChunk', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

content-type

enum<string>

Available options:

multipart/form-data

Path Parameters

chunkedFileId

string

required

Body

multipart/form-data

chunkedFilePart

Chunked File Part · object

required

Show child attributes

fileChunk

file

required

Response

204

No Content

Create Chunked FileThis endpoint allows you to begin the process of importing a file in multiple chunks. Calling this endpoint returns a `{chunkedFileId}` to use in subsequent steps. ### Permissions - `api.file-manager.write`

⌘I

Add Chunked File Part

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'chunkedFilePart={
  "offset": 1,
  "size": 1
}' \
  --form fileChunk='@example-file'

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part"

files = { "fileChunk": ("example-file", open("example-file", "rb")) }
payload = { "chunkedFilePart": "{
  \"offset\": 1,
  \"size\": 1
}" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('chunkedFilePart', '{
  "offset": 1,
  "size": 1
}');
form.append('fileChunk', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/chunked-files/{chunkedFileId}/part")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunkedFilePart\"\r\n\r\n{\r\n  \"offset\": 1,\r\n  \"size\": 1\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileChunk\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body