Complete a multipart upload

POST

files

upload

multipart

complete

Complete a multipart upload

curl --request POST \
  --url https://api.orion.file.ai/prod/v1/files/upload/multipart/complete \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "id": "upload_abc123xyz",
  "key": "org_123/workspace_456/device/file_abc/document.pdf",
  "parts": [
    {
      "partNumber": 1,
      "eTag": "\"etag1\""
    },
    {
      "partNumber": 2,
      "eTag": "\"etag2\""
    }
  ]
}
'

import requests

url = "https://api.orion.file.ai/prod/v1/files/upload/multipart/complete"

payload = {
    "id": "upload_abc123xyz",
    "key": "org_123/workspace_456/device/file_abc/document.pdf",
    "parts": [
        {
            "partNumber": 1,
            "eTag": "\"etag1\""
        },
        {
            "partNumber": 2,
            "eTag": "\"etag2\""
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 'upload_abc123xyz',
    key: 'org_123/workspace_456/device/file_abc/document.pdf',
    parts: [{partNumber: 1, eTag: '"etag1"'}, {partNumber: 2, eTag: '"etag2"'}]
  })
};

fetch('https://api.orion.file.ai/prod/v1/files/upload/multipart/complete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "location": "https://s3.amazonaws.com/bucket/org_123/workspace_456/device/file_abc/document.pdf",
  "key": "org_123/workspace_456/device/file_abc/document.pdf",
  "etag": "\"abc123def456-2\"",
  "success": true
}

Request · Guide: Upload files

More details

After uploading all parts using the presigned URLs from the initiate endpoint, call this endpoint with the ID, key, and all part ETags to finalize the upload.The input should contain:

id: the ID from the multipart upload initiation (previously called uploadId)
key: the S3 key from the multipart upload initiation
parts: array of objects with partNumber and eTag for each uploaded part

Authorizations

x-api-key

string

header

required

API key for authentication

Headers

Idempotency-Key

string

Optional opaque key (max 255 chars, UUIDv4 recommended) making this request idempotent for 24h: a retry with the same key and body replays the original response with Idempotent-Replayed: true.

Body

application/json

string

required

ID from the multipart upload initiation

Example:

"upload_abc123xyz"

key

string

required

S3 key from the multipart upload initiation

Example:

"org_123/workspace_456/device/file_abc/document.pdf"

parts

object[]

required

Array of completed parts with part numbers and ETags

Show child attributes

Example:

[
  { "partNumber": 1, "eTag": "\"etag1\"" },
  { "partNumber": 2, "eTag": "\"etag2\"" }
]

Response

Multipart upload completed successfully