Skip to main content
PUT
/
api
/
datasets
/
{dataset_id}
/
shortcut-guidance
/
classes
/
{class_name}
Upsert Shortcut Guidance Class
curl --request PUT \
  --url https://api.example.com/api/datasets/{dataset_id}/shortcut-guidance/classes/{class_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exemplar_path": "<string>",
  "mask_png_base64": "<string>",
  "bbox": {},
  "strokes": "<unknown>"
}
'
{
  "id": "<string>",
  "class_name": "<string>",
  "exemplar_path": "<string>",
  "mask_url": "<string>",
  "bbox": {},
  "strokes": "<unknown>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

dataset_id
string
required
class_name
string
required

Cookies

antidote_session
string | null

Body

application/json
exemplar_path
string
required
mask_png_base64
string
required
bbox
Bbox · object
strokes
any

Response

Successful Response

id
string
required
class_name
string
required
exemplar_path
string
required
mask_url
string
required
bbox
Bbox · object
strokes
any
created_at
string | null
updated_at
string | null
updated_by
string | null