Skip to main content
GET
Upload status

Authorizations

Authorization
string
header
required

A workspace API key.

Query Parameters

projectId
string

Project that owns the upload. Omit for a Library upload that belongs to no project; then omit it on every later call too.

Required string length: 1 - 200
uploadId
string
required

Sigmora upload-session id returned by upload prepare.

Pattern: ^aus_[a-f0-9]{48}$
contentId
string
required

Storage content id returned by upload prepare.

Required string length: 1 - 200

Response

Success.

success
boolean
required
requestedUploadId
string
required

Upload id supplied by the caller, before lineage resolution.

Pattern: ^aus_[a-f0-9]{48}$
uploadId
string
required

Current leaf upload id after following restart lineage.

Pattern: ^aus_[a-f0-9]{48}$
projectId
string | null
required

Project that owns the upload; null for a Library upload.

Required string length: 1 - 200
assetId
string
required

Stable asset reserved for the upload.

Required string length: 1 - 200
contentId
string
required

Storage content id bound to the current upload.

Required string length: 1 - 200
lane
enum<string>
required
Available options:
single,
multipart
state
enum<string>
required
Available options:
prepared,
restarting,
finalizing,
completed,
failed,
superseded
contentStatus
string | null
required
expiresAt
string
required
completedAt
string | null
required
previewUrl
string<uri> | null
required
supersededByUploadId
string | null
required
Pattern: ^aus_[a-f0-9]{48}$
recovery
object
required
ingestReady
boolean

True once the upload is completed and storage has admitted the file; poll until it is.

{key}
any