POST /v3/multipart-uploads

1 min

POST

https://api.cmp.optimizely.com/v3/multipart-uploads

Experimental Create pre-signed URLs for multipart upload of large files

Body Parameters

bodyobjectrequired
- file_sizeintegerrequired
  Example
  104857600
  Description
  Size of the file in bytes
  Minimum
  1
  Maximum
  5497558138880
- part_sizeinteger
  Example
  6000000
  Description
  The size of each part of the file to be uploaded. The size of the last part can be smaller and hence can be ignored. upload_part_count is calculated based on file_size and part_size. The maximum allowed upload_part_count is 10000. So use larger part_size for larger files to keep upload_part_count under 10000.
  Default
  5242880
  Minimum
  5242880
  Maximum
  5368709120

Responses

201Successful operation

object
- idstringrequired
  Example
  abcdef1234567890
  Description
  ID of the multipart upload
- expires_atstring<date-time>required
  Example
  2025-03-03T12:00:00Z
  Description
  Expiration time of the upload URLs
  Format
  date-time
- upload_part_countintegerrequired
  Example
  10
  Description
  Number of parts for the upload
- upload_part_urlsstring[]required
  Example
```
[
  "https://s3.amazonaws.com/xyz/abcdef1234567890/0",
  "https://s3.amazonaws.com/xyz/abcdef1234567890/1"
]
```
  Description
  Array of pre-signed URLs for each part. Each file part must be uploaded to the URL using PUT requests following the order of the URLs
- linksobjectrequired
  - completestring<uri>required
    Example
    https://api.cmp.optimizely.com/v3/multipart-uploads/abcdef1234567890/complete
    Description
    URL to complete the upload
    Format
    uri
  - statusstring<uri>required
    Example
    https://api.cmp.optimizely.com/v3/multipart-uploads/abcdef1234567890/status
    Description
    URL to check the upload status
    Format
    uri

Response Headers

Content-Encodingstring
Example
gzip
Description
Response is always gzip compressed
Allowed
gzip

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/multipart-uploads \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "file_size": 104857600,
     "part_size": 5242880
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "file_size": 104857600,
   "part_size": 5242880
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/multipart-uploads", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/multipart-uploads")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "file_size": 104857600,
   "part_size": 5242880
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/multipart-uploads"

payload = json.dumps({
   "file_size": 104857600,
   "part_size": 5242880
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Successful operation
{
  "id": "abcdef1234567890",
  "expires_at": "2025-03-03T12:00:00Z",
  "upload_part_count": 10,
  "upload_part_urls": [
    ""
  ],
  "links": {
    "complete": "https://api.cmp.optimizely.com/v3/multipart-uploads/abcdef1234567890/complete",
    "status": "https://api.cmp.optimizely.com/v3/multipart-uploads/abcdef1234567890/status"
  }
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}