Skip to main content
GET
Get an owned or public sample
Returns an owned sample with its current and historical inference jobs, or a public sample when the path id is a public share UUID. The required ownership field discriminates the two response shapes.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

Owned or public sample detail

An owned sample's curated read model and its 50 newest inference jobs. jobCount is the uncapped total.

ownership
enum<string>
required
Available options:
mine
id
string<uuid>
required
name
string | null
required

Human-friendly display name, or null if unset (falls back to filename).

filename
string
required

Original uploaded filename.

status
string
required

Lifecycle status: uploading, upload_failed, deid_running, deid_failed, preprocessing, ready, or preprocess_failed.

fileSize
string
required

Uploaded file size in bytes (string-encoded 64-bit integer).

widthPx
integer | null
required

Level-0 width in pixels, or null before the dimensions probe completes.

heightPx
integer | null
required

Level-0 height in pixels, or null before the dimensions probe completes.

mpp
number | null
required

Effective isotropic microns per pixel (user override → calibrated slide value), or null when the sample has no usable scale yet.

tags
string[]
required

The sample's canonical tag strings, sorted alphabetically.

createdAt
string<date-time> | null
required
expiresAt
string<date-time> | null
required

When the sample moves to Trash. Null when it never expires.

expiresAtSource
enum<string> | null
required

org_default = derived from the org policy at upload time. custom = set by an explicit expiration call (a date or a never-expire pin). Null when the sample has no expiration and no org policy applies.

Available options:
org_default,
custom,
null
expiresInDays
integer | null
required

Whole days until expiry, clamped at 0 for a sample at/past its date but not yet swept. Null when the sample never expires.

willExpire
boolean
required

True when the sample has an expiration date set.

trashedAt
string<date-time> | null
required

When the sample entered Trash, or null if it is still active. Trashed samples are permanently deleted 7 days after this time.

jobs
object[]
required
Maximum array length: 50
jobCount
integer
required

Total inference-job count for the sample before the 50-job cap.

Required range: x >= 0
segmentation
object
required