Search Modaic documentation

Find a Modaic guide or API reference

Reference›API›uploads

Get upload

New

Inspect parts and validation status.

GET/v1/knowledge-base/uploads/{uploadId}

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

uploadIdUUIDrequired
Upload session ID.
workspacestring
Workspace slug. Omit to use the authenticated account workspace.

Response

idUUID
Upload ID.
namestring
Reserved resource name.
kinddataset | artifact
Resource kind.
sha256string
Whole-file checksum.
sizeBytesinteger
Whole-file size.
statuspending | processing | completed | failed | cancelled | expired
Use only completed uploads with a non-null result.
partSizeBytesinteger
67108864 (64 MiB).
partsarray
partNumber, sha256, sizeBytes, and uploaded for prepared parts.
resultobject | null
On completion: name, kind, path, sha256, sizeBytes, commitSha.
errorobject | null
Failure code and message.
createdAtdatetime
expiresAtdatetime
Was this page helpful?