Complete a multipart upload and create the upload record

POST /uploads/multipart/{uploadId}/complete

Path parameters

uploadId string Required

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Body

storageKey string Required
multipartUploadId string Required
fileName string Required
mimeType string Required
purpose string Required
One of source_doc playbook
sizeBytes integer Required
parts object[] Required
Show 2 fields
- partNumber integer Required
- etag string Required
artifactId string

Returns

upload object
The persisted upload/document row, as returned by every route that creates or mutates upload content (create, save draft, rename, delete, new version, revision-apply, redline edits).
Show 19 fields
- id string
- artifactId string | null
- orgId string
- createdByUserId string | null
- fileName string
- mimeType string
- sizeBytes integer
- purpose string
  One of source_doc playbook
- clientReferenceId string | null
- documentSeriesId string
- documentVersion integer
- parentUploadId string | null
- versionKind string
  One of original working_draft
- storageKey string | null
- contentSha256 string | null
- hasBinary boolean
- status string
- createdAt string
- updatedAt string

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/uploads/multipart/upload_example/complete" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{"storageKey":"text","multipartUploadId":"multipart_upload_example","fileName":"text","mimeType":"text","purpose":"source_doc","sizeBytes":0,"parts":["chg_1"]}'

const response = await fetch("https://api.scaffoldyourdocs.com/uploads/multipart/upload_example/complete", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"storageKey":"text","multipartUploadId":"multipart_upload_example","fileName":"text","mimeType":"text","purpose":"source_doc","sizeBytes":0,"parts":["chg_1"]})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/uploads/multipart/upload_example/complete",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={"storageKey": "text", "multipartUploadId": "multipart_upload_example", "fileName": "text", "mimeType": "text", "purpose": "source_doc", "sizeBytes": 0, "parts": ["chg_1"]},
)

Response (shape)

{
  "upload": {
    "id": "string",
    "artifactId": "string",
    "orgId": "string",
    "createdByUserId": "string",
    "fileName": "string",
    "mimeType": "string",
    "sizeBytes": 0,
    "purpose": "source_doc",
    "clientReferenceId": "string",
    "documentSeriesId": "string",
    "documentVersion": 0,
    "parentUploadId": "string",
    "versionKind": "original",
    "storageKey": "string",
    "contentSha256": "string",
    "hasBinary": true,
    "status": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}