Skip to main content
GET
Get segmentation metadata

Authorizations

Authorization
string
header
required

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

Path Parameters

segmentation_id
string<uuid>
required

Response

Successful Response

A segmentation's metadata: where it came from, whether its annotations are ready, and its ROI count. annotation_processing_status == ready is the signal the mask/annotations are usable.

The mask's storage location is intentionally omitted: it is an internal S3 path (bucket + key layout) with no client value, and results are downloaded through the export/* endpoints. Keeping it server-side avoids leaking the bucket name and key scheme to public API-key callers.

id
string
required
image_id
string
required
source_type
enum<string>
required
Available options:
model_prediction,
refinement
annotation_processing_status
enum<string>
required
Available options:
creating,
ready
annotation_count
integer
required
created_at
string<date-time>
required
parent_segmentation_id
string | null
model_id
string | null
pipeline_id
string | null
job_id
string | null