Skip to main content
GET
Get upload status

Authorizations

Authorization
string
header
required

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

Path Parameters

image_id
string
required

Response

Successful Response

An image's upload lifecycle and metadata: enough to know when a freshly uploaded image is ready to run a prediction against.

name
string
required

Filename or label for the image.

Example:

"sample.tif"

size
integer
required

Total size of the image file in bytes.

Example:

4194304

id
string
required
created_at
string<date-time>
required
upload_status
enum<string>
required

Lifecycle of a resumable S3 multipart image upload.

uploading -> row created, bytes still being PUT directly to S3 processing -> object landed in S3, backend is converting it off the event loop ready -> conversion done, shape populated, image is usable failed -> aborted or conversion failed (orphan-sweep cron will reap it)

Available options:
uploading,
processing,
ready,
failed
image_type
enum<string>
default:TIFF

Image format. Only TIFF is currently supported.

Available options:
TIFF
additional_info
Additional Info · object

Arbitrary JSON metadata to store alongside the image.

folder_id
string<uuid> | null

The folder the image is in, if any; it must belong to your organization. API clients typically have no folders and omit this.

shape
integer[] | null
processed_at
string<date-time> | null
upload_error
string | null