Skip to main content
POST
/
api
/
v1
/
shared
/
uploads
/
{upload_id}
/
finalize
Finalize
curl --request POST \
  --url https://api.example.com/api/v1/shared/uploads/{upload_id}/finalize \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "kind": "<string>",
  "originalFilename": "<string>",
  "sizeBytes": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "downloadUrl": "<string>",
  "derivatives": {
    "thumb": "<string>",
    "medium": "<string>",
    "large": "<string>",
    "preview": "<string>"
  },
  "width": 123,
  "height": 123,
  "pageCount": 123,
  "threatName": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
upload_id
string<uuid>
required

Response

Successful Response

Outbound API shape for the client — used by finalize + status endpoints.

​
id
string<uuid>
required
​
status
string
required
​
kind
string
required
​
originalFilename
string
required
​
sizeBytes
integer
required
​
createdAt
string<date-time>
required
​
downloadUrl
string | null
​
derivatives
UploadDerivativesDTO · object

URLs for the worker-generated variants. Populated only when status=ready.

​
width
integer | null
​
height
integer | null
​
pageCount
integer | null
​
threatName
string | null