Skip to main content
GET
Get upload status

Authorizations

x-api-key
string
header
required

ROOTKey API key (rk_live_... for production, rk_test_... for the test network).

Path Parameters

uploadId
string
required

The uploadId returned by Start an upload.

Pattern: ^upl_[0-9a-f]{32}$
Example:

"upl_3f2b8c1e5a7d4e9b9c2a1d6e8f0a4b7c"

Response

The upload.

uploadId
string
fileId
string
status
enum<string>

PENDING: waiting for the bytes or for you to complete it. VERIFYING: a multipart upload being checked. FINALIZING: being anchored. COMPLETED: the file exists. FAILED: see failureCode. EXPIRED, ABORTED: ended without a file.

Available options:
PENDING,
VERIFYING,
FINALIZING,
COMPLETED,
FAILED,
EXPIRED,
ABORTED
mode
enum<string>
Available options:
single,
multipart
size
integer

The declared size in bytes.

expiresAt
string<date-time>
chainId
integer

Once COMPLETED.

transactionHash
string

Once COMPLETED.

failureCode
string

When FAILED: the errorCode that explains why, such as file_upload_checksum_mismatch.