Individuals

List all individuals

get

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

Query parameters

drive_idstring · uuidRequired

The id of the drive to get individuals for

pageinteger · nullableOptional

The page to query

Default: 0

limitinteger · nullableOptional

The limit that is fetched per page

Default: 100

labeledboolean · nullableOptional

If set, only labeled individuals will be returned

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

Responses

200

A list of all individuals

application/json

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

get/individuals

GET /individuals?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "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,
        "signed_url": "text"
      },
      "individual_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "preview_image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "frame": 1,
      "signed_url": "text"
    }
  }
]

Get an individual

get

Get an individual by id

Path parameters

individual_idstring · uuidRequired

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

Responses

200

The individual

application/json

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

get/individuals/{individual_id}

GET /individuals/{individual_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

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

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

namestring · nullableOptional

The new name/label for the individual

Responses

200

The updated individual

application/json

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

put/individuals/{individual_id}

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

{
  "name": "text",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

Hides the given individuals by id

put

Hide individuals by their ids.

Path parameters

drive_idstring · uuidRequired

The id of the drive to hide individuals in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

individual_idsstring · uuid[]Required

The ids of the individuals to hide

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

put/individuals/{drive_id}/individual/disable

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

{
  "individual_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

face_idsstring · uuid[]Required

The ids of the faces to create the individual from

individual_namestringRequired

The name/label for the individual

old_individual_idstring · uuid · nullableOptional

If provided, the individual that the faces are being taken from (must be a labeled individual)

Responses

200

The new individual

application/json

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

post/individuals/{drive_id}/individual/create

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

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

{
  "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,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

Assign a face to another individual

put

Assign face(s) to an individual.

Path parameters

drive_idstring · uuidRequired

The id of the drive to create the individual in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

face_idsstring · uuid[]Required

The id of the faces to assign

individual_idstring · uuidRequired

The id of the individual to assign the face to (must be a labeled individual)

old_individual_idstring · uuid · nullableOptional

If provided, the individual that the faces are being taken from (must be a labeled individual)

Responses

200

The new individual

application/json

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

put/individuals/{drive_id}/individual/assign

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

{
  "face_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "individual_id": "123e4567-e89b-12d3-a456-426614174000",
  "old_individual_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

Merges individuals together into one

put

Merge multiple individuals into one, combining their faces and setting a new name.

Path parameters

drive_idstring · uuidRequired

The id of the drive to get faces for

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

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

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

put/individuals/{drive_id}/individual/merge

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

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

{
  "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,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

Delete faces from an individual

delete

Delete faces from an individual. NOTE: permanently deletes the faces from the DB.

Path parameters

drive_idstring · uuidRequired

The id of the drive to create the individual in

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

face_idsstring · uuid[]Required

The id of the faces to assign

individual_idstring · uuidRequired

The id of the individual to delete the face from (must be a labeled individual)

Responses

200

The new individual

application/json

idstring · uuidRequired

namestringRequired

labeledboolean · nullableOptional

404

Not found

422

Validation Error

application/json

delete/individuals/{drive_id}/individual/faces

DELETE /individuals/{drive_id}/individual/faces HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "face_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "individual_id": "123e4567-e89b-12d3-a456-426614174000",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "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,
      "signed_url": "text"
    },
    "individual_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "preview_image": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "frame": 1,
    "signed_url": "text"
  }
}

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

Header parameters

passwordstring · nullableOptional

The password header to use to fetch the preview

Body

Responses

200

A list of all faces for an individual

application/json

idstring · uuidRequired

individual_idstring · uuid · nullableOptional

404

Not found

422

Validation Error

application/json

get/individuals/{individual_id}/faces

GET /individuals/{individual_id}/faces HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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