Individuals | Shade Academy

List all individuals

get

Get a list of all significant individuals. Note: an individual is only sig and returned if it contains >3 faces.

Query parameters

drive_idstring · uuidRequired

The id of the drive to get individuals for

pageany ofOptional

The page to query

Default: 0

integerOptional

or

nullOptional

limitany ofOptional

The limit that is fetched per page

Default: 100

integerOptional

or

nullOptional

Responses

200

A list of all individuals

application/json

404

Not found

422

Validation Error

application/json

get

GET /individuals?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "labeled": true,
    "preview_face": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "bbox": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "face_preview": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "frame": 1
      }
    },
    "preview_image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  }
]

Get an individual

get

Get an individual by id

Path parameters

individual_idstring · uuidRequired

Responses

200

The individual

application/json

404

Not found

422

Validation Error

application/json

get

GET /individuals/{individual_id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "labeled": true,
  "preview_face": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1
  }
}

Update an individual

put

Update an individual with a new name/label.

Path parameters

individual_idstring · uuidRequired

The id of the individual to be updated

Body

nameany ofOptional

The new name/label for the individual

stringOptional

or

nullOptional

Responses

200

The updated individual

application/json

404

Not found

422

Validation Error

application/json

put

PUT /individuals/{individual_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "labeled": true,
  "preview_face": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1
  }
}

Disable individual

put

Create an individual from a set of faces defined by the user.

Path parameters

drive_idstring · uuidRequired

The id of the drive to disable individual

Body

individual_idsstring · uuid[]Required

The individuals within a drive

Responses

200

Disable individual

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

PUT /individuals/{drive_id}/individual/disable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "individual_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Create an individual from faces

post

Create an individual from a set of faces defined by the user.

Path parameters

drive_idstring · uuidRequired

The id of the drive to create the individual in

Body

face_idsstring · uuid[]Required

The ids of the faces to create the individual from

individual_namestringRequired

The name/label for the individual

Responses

200

The new individual

application/json

404

Not found

422

Validation Error

application/json

post

POST /individuals/{drive_id}/individual/create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "face_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "individual_name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "labeled": true,
  "preview_face": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1
  }
}

Assign a face to another individual

put

Assign a face to an individual.

Path parameters

drive_idstring · uuidRequired

The id of the drive to create the individual in

Body

face_idstring · uuidRequired

The id of the face to assign

individual_idstring · uuidRequired

The id of the individual to assign the face to

Responses

200

The new individual

application/json

404

Not found

422

Validation Error

application/json

put

PUT /individuals/{drive_id}/individual/assign HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "face_id": "123e4567-e89b-12d3-a456-426614174000",
  "individual_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "labeled": true,
  "preview_face": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1
  }
}

Merges individuals together into one

put

Path parameters

drive_idstring · uuidRequired

The id of the drive to get faces for

Body

individual_idsstring · uuid[]Required

The ids of the individuals to merge

namestringRequired

The new name given to the combined individuals

Responses

200

The newly merged individual

application/json

404

Not found

422

Validation Error

application/json

put

PUT /individuals/{drive_id}/individual/merge HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "individual_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "labeled": true,
  "preview_face": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1
  }
}

List all faces for an individual

get

Get a list of all faces for an individual by id.

Path parameters

individual_idstring · uuidRequired

The id of the individual to get faces for

Responses

200

A list of all faces for an individual

application/json

404

Not found

422

Validation Error

application/json

get

GET /individuals/{individual_id}/faces HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "bbox": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "face_preview": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1
    }
  }
]