Skip to main content
POST
Share a result

Authorizations

Authorization
string
header
required

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

Body

application/json

Share one completed segmentation. segmentation_id is the one GET /predict/{prediction_id} returns once the run is COMPLETED.

segmentation_id
string<uuid>
required
Example:

"7d9e2f10-4a5b-4c6d-8e9f-0a1b2c3d4e5f"

Response

Successful Response

A share of one segmentation. access says who it reaches and role what they can do; url is the link to send.

id
string<uuid>
required
segmentation_id
string<uuid>
required
access
enum<string>
required

Who the share reaches. Always anyone_with_link today.

Available options:
anyone_with_link,
user
role
enum<string>
required

What they can do. Always viewer today: shared results are read-only.

Available options:
viewer,
editor
view_count
integer
required

How many times the link has been opened.

created_at
string<date-time>
required
url
string | null

The link to send, for anyone_with_link shares. Anyone holding it can view.

last_viewed_at
string<date-time> | null
revoked_at
string<date-time> | null

When the share was turned off. A revoked link no longer opens.