Skip to main content
POST
Run a prediction

Authorizations

Authorization
string
header
required

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

Body

application/json

Run a model over one uploaded image. image_id must be ready (see GET /upload/{image_id}) and model_id must be one of the ids returned by GET /models.

image_id
string
required
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

model_id
string<uuid>
required
Example:

"c0ffee00-1234-5678-9abc-def012345678"

segmentation_channels
SegmentationChannels · object | null

For a multiplex image only: which channels to segment on, 0-based. Segmentation reads at most 3 channels, so it uses a nuclear stain plus an optional membrane or cytoplasm marker. Defaults to channel 0 as the nucleus and channel 1 as the cytoplasm.

channel
integer | null

For a multiplex image only: segment this one channel on its own, 0-based, instead of segmentation_channels. Run one prediction per channel to use a different model on each.

Required range: x >= 0

Response

Successful Response

Acknowledgement that a prediction was queued. prediction_id is the one to poll.

prediction_id
string
required
Example:

"b1e5c7d2-9a4f-4c3b-8e2d-1f6a7b8c9d0e"

status
string
required
Allowed value: "submitted"