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
required
Example:

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

Response

Successful Response

Acknowledgement that a prediction was queued. status is submitted for a fresh run, or skipped when an identical prediction is already in flight — in both cases prediction_id is the one to poll.

prediction_id
string
required
Example:

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

status
enum<string>
required
Available options:
submitted,
skipped
reason
string | null

Why an identical prediction was skipped, when status is skipped.