Skip to main content
GET
/
api
/
datasets
/
{dataset_id}
/
shortcut-guidance
/
classes
Get Shortcut Guidance Classes
curl --request GET \
  --url https://api.example.com/api/datasets/{dataset_id}/shortcut-guidance/classes \
  --header 'Authorization: Bearer <token>'
{
  "dataset_id": "<string>",
  "classes": [
    {
      "class_name": "<string>",
      "exemplar": {
        "path": "<string>",
        "name": "<string>",
        "preview_url": "<string>"
      },
      "sample_options": [
        {
          "path": "<string>",
          "name": "<string>",
          "preview_url": "<string>"
        }
      ],
      "annotation": {
        "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

Cookies

antidote_session
string | null

Response

Successful Response

dataset_id
string
required
classes
ShortcutGuidanceClassItem · object[]