# Faces

## Get the individual a face is for

> Get the individual that a face is for by id

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/faces/{face_id}/individual":{"get":{"tags":["faces"],"summary":"Get the individual a face is for","description":"Get the individual that a face is for by id","operationId":"read_face_individual_faces__face_id__individual_get","parameters":[{"name":"face_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The face id","description":"The id of the face whose individual to get"},"description":"The id of the face whose individual to get"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_face_individual_faces__face_id__individual_get"}}}},"responses":{"200":{"description":"The individual","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_read_face_individual_faces__face_id__individual_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_read_face_individual_faces__face_id__individual_get"},"IndividualDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"labeled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Labeled"},"preview_face":{"anyOf":[{"$ref":"#/components/schemas/FaceDTO"},{"type":"null"}]},"preview_image":{"anyOf":[{"$ref":"#/components/schemas/PreviewDTO"},{"type":"null"}]}},"type":"object","required":["id","name"],"title":"IndividualDTO"},"FaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"bbox":{"additionalProperties":{"type":"integer"},"type":"object","title":"Bbox"},"face_preview":{"$ref":"#/components/schemas/PreviewDTO"},"individual_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Individual Id"}},"type":"object","required":["id","bbox","face_preview"],"title":"FaceDTO"},"PreviewDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"frame":{"type":"integer","title":"Frame"},"signed_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signed Url"}},"type":"object","required":["id","frame"],"title":"PreviewDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get the asset a face is for

> Get the asset that a face is for by id

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/faces/{face_id}/asset":{"get":{"tags":["faces"],"summary":"Get the asset a face is for","description":"Get the asset that a face is for by id","operationId":"read_face_asset_faces__face_id__asset_get","parameters":[{"name":"face_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The face id","description":"The id of the face whose asset to get"},"description":"The id of the face whose asset to get"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_face_asset_faces__face_id__asset_get"}}}},"responses":{"200":{"description":"The asset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_read_face_asset_faces__face_id__asset_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_read_face_asset_faces__face_id__asset_get"},"AssetDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id"},"path":{"type":"string","title":"Path"},"name":{"type":"string","title":"Name"},"extension":{"type":"string","title":"Extension"},"updated":{"type":"string","format":"date-time","title":"Updated"},"created":{"type":"string","format":"date-time","title":"Created"},"type":{"$ref":"#/components/schemas/AssetType"},"size_bytes":{"type":"integer","title":"Size Bytes"},"stack_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Stack Id"},"stack_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stack Number"},"is_fs_draft_blob":{"type":"boolean","title":"Is Fs Draft Blob"},"is_fs_null_blob":{"type":"boolean","title":"Is Fs Null Blob"},"rating":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rating"},"ai_indexed":{"type":"boolean","title":"Ai Indexed"},"system_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"System Metadata","default":{}},"custom_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Metadata","default":{}},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"palette":{"items":{"items":{"type":"integer"},"type":"array"},"type":"array","title":"Palette"},"ocr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocr"},"transcription_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transcription Id"},"faces_present":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Faces Present"},"content_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Content Length"},"preview_job_state":{"$ref":"#/components/schemas/JobState"},"metadata_job_state":{"$ref":"#/components/schemas/JobState"},"core_vision_job_state":{"$ref":"#/components/schemas/JobState"},"color_palette_job_state":{"$ref":"#/components/schemas/JobState"},"core_audio_job_state":{"$ref":"#/components/schemas/JobState"},"audio_job_state":{"$ref":"#/components/schemas/JobState"},"facial_recognition_job_state":{"$ref":"#/components/schemas/JobState"},"proxy_job_state":{"$ref":"#/components/schemas/JobState"},"audio_proxy_job_state":{"$ref":"#/components/schemas/JobState"},"transcription_job_state":{"$ref":"#/components/schemas/JobState"},"objects":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Objects"},"texture_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Texture Data"},"integration_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Integration Data"},"preview_images":{"items":{"$ref":"#/components/schemas/PreviewDTO"},"type":"array","title":"Preview Images"},"custom_thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}]},"proxy":{"anyOf":[{"$ref":"#/components/schemas/ProxyDTO"},{"type":"null"}]},"audio_proxy":{"anyOf":[{"$ref":"#/components/schemas/ProxyDTO"},{"type":"null"}]}},"type":"object","required":["id","drive_id","path","name","extension","updated","created","type","size_bytes","is_fs_draft_blob","is_fs_null_blob","ai_indexed","palette","preview_job_state","metadata_job_state","core_vision_job_state","color_palette_job_state","core_audio_job_state","facial_recognition_job_state","proxy_job_state","audio_proxy_job_state","transcription_job_state","preview_images"],"title":"AssetDTO","description":"Full asset DTO with relationship fields that require eager loading."},"AssetType":{"type":"string","enum":["IMAGE","VIDEO","AUDIO","DOCUMENT","HDR","HDRI","PHOTOSHOP","ILLUSTRATOR","EXR","OBJECT","VECTOR","OTHER","MAYA","MAX","BLENDER","HOUDINI","UNREAL","UNITY","AFTER_EFFECTS","MOGRT"],"title":"AssetType"},"JobState":{"type":"string","enum":["NOT_STARTED","IN_PROGRESS","COMPLETED","FAILED","INSUFFICIENT_CREDITS"],"title":"JobState","description":"Enum for asset job states"},"PreviewDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"frame":{"type":"integer","title":"Frame"},"signed_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signed Url"}},"type":"object","required":["id","frame"],"title":"PreviewDTO"},"ProxyDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"ProxyDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /faces

> List all unclustered faces

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/faces":{"get":{"tags":["faces"],"summary":"List all unclustered faces","operationId":"read_faces_faces_get","parameters":[{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Drive ID","description":"The drive id to list faces for"},"description":"The drive id to list faces for"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page number","description":"The page to query","default":0},"description":"The page to query"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit per page","description":"The limit that is fetched per page","default":100},"description":"The limit that is fetched per page"},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_faces_faces_get"}}}},"responses":{"200":{"description":"List of all unclustered faces","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FaceDTO"},"title":"Response Read Faces Faces Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_read_faces_faces_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_read_faces_faces_get"},"FaceDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"bbox":{"additionalProperties":{"type":"integer"},"type":"object","title":"Bbox"},"face_preview":{"$ref":"#/components/schemas/PreviewDTO"},"individual_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Individual Id"}},"type":"object","required":["id","bbox","face_preview"],"title":"FaceDTO"},"PreviewDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"frame":{"type":"integer","title":"Frame"},"signed_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signed Url"}},"type":"object","required":["id","frame"],"title":"PreviewDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get the dynamic views for a drive

> Get the dynamic views for a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/dynamic-views":{"get":{"tags":["faces"],"summary":"Get the dynamic views for a drive","description":"Get the dynamic views for a drive","operationId":"get_drive_dynamic_views_route_dynamic_views_get","parameters":[{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_drive_dynamic_views_route_dynamic_views_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DynamicView"},"title":"Response Get Drive Dynamic Views Route Dynamic Views Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_drive_dynamic_views_route_dynamic_views_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_drive_dynamic_views_route_dynamic_views_get"},"DynamicView":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForStorage"},"type":"array"},{"type":"null"}],"title":"Filters"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"},"is_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Locked"},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private"},"display_settings":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewDisplaySettings"},{"type":"null"}]},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewIconType"},{"type":"null"}]},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort"}},"type":"object","required":["id","name"],"title":"DynamicView"},"AddedFilterForStorage":{"properties":{"id":{"title":"Id"},"options":{"items":{"$ref":"#/components/schemas/FilterOption"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"},"ignore_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Options"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForStorage"},"FilterOption":{"properties":{"client_val":{"type":"string","title":"Client Val"},"server_val":{"type":"string","title":"Server Val"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["client_val","server_val"],"title":"FilterOption"},"FilterClauseVal":{"type":"string","enum":["is","is any of","is not","is true","is false","is not true","is not false","has","doesn't have","before","after","between","is directly in","is under","is not in","<","< any of","<=","<= any of",">","> any of",">=",">= any of","hasn't started","in progress of","completed","failed","includes","does not include","contains","does not contain","does not start with","starts with","end with","is empty","is not empty"],"title":"FilterClauseVal","description":"Filter Clause Values Enum. Contains all filter clause values"},"DynamicViewDisplaySettings":{"properties":{"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"flatten_directories":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Flatten Directories"}},"type":"object","title":"DynamicViewDisplaySettings"},"DynamicViewIconType":{"type":"string","enum":["color","emoji","url"],"title":"DynamicViewIconType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /dynamic-views

> Add a dynamic view for a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/dynamic-views":{"post":{"tags":["faces"],"summary":"Add a dynamic view for a drive","operationId":"add_dynamic_view_route_dynamic_views_post","parameters":[{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_add_dynamic_view_route_dynamic_views_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_add_dynamic_view_route_dynamic_views_post":{"properties":{"name":{"type":"string","title":"The dynamic view name","description":"The dynamic view name to update"},"display_settings":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewDisplaySettings"},{"type":"null"}],"title":"The dynamic view display settings","description":"The dynamic view display settings to update"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view icon","description":"The dynamic view icon to update"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewIconType"},{"type":"null"}],"title":"The dynamic view icon type","description":"The dynamic view icon type to update"},"is_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is locked","description":"If locked, other users cannot modify the dynamic view.","default":false},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is private","description":"If private, only the owner can see this dynamic view.","default":false},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForStorage"},"type":"array"},{"type":"null"}],"title":"The dynamic view filters","description":"The dynamic view filters to update","default":[]},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view sort","description":"The dynamic view sort to update (include '-' at beginning for descending)"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["name"],"title":"Body_add_dynamic_view_route_dynamic_views_post"},"DynamicViewDisplaySettings":{"properties":{"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"flatten_directories":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Flatten Directories"}},"type":"object","title":"DynamicViewDisplaySettings"},"DynamicViewIconType":{"type":"string","enum":["color","emoji","url"],"title":"DynamicViewIconType"},"AddedFilterForStorage":{"properties":{"id":{"title":"Id"},"options":{"items":{"$ref":"#/components/schemas/FilterOption"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"},"ignore_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Options"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForStorage"},"FilterOption":{"properties":{"client_val":{"type":"string","title":"Client Val"},"server_val":{"type":"string","title":"Server Val"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["client_val","server_val"],"title":"FilterOption"},"FilterClauseVal":{"type":"string","enum":["is","is any of","is not","is true","is false","is not true","is not false","has","doesn't have","before","after","between","is directly in","is under","is not in","<","< any of","<=","<= any of",">","> any of",">=",">= any of","hasn't started","in progress of","completed","failed","includes","does not include","contains","does not contain","does not start with","starts with","end with","is empty","is not empty"],"title":"FilterClauseVal","description":"Filter Clause Values Enum. Contains all filter clause values"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update a dynamic view for a drive

> Modify a dynamic view for a drive

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/dynamic-views/{dynamic_view_id}":{"put":{"tags":["faces"],"summary":"Update a dynamic view for a drive","description":"Modify a dynamic view for a drive","operationId":"update_drive_dynamic_view_route_dynamic_views__dynamic_view_id__put","parameters":[{"name":"dynamic_view_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dynamic view id"}},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_drive_dynamic_view_route_dynamic_views__dynamic_view_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_update_drive_dynamic_view_route_dynamic_views__dynamic_view_id__put":{"properties":{"name":{"type":"string","title":"The dynamic view name","description":"The dynamic view name to update"},"filters":{"items":{"$ref":"#/components/schemas/AddedFilterForStorage"},"type":"array","title":"The dynamic view filters","description":"The dynamic view filters to update"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"The dynamic view columns","description":"The dynamic view columns to update"},"display_settings":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewDisplaySettings"},{"type":"null"}],"title":"The dynamic view display settings","description":"The dynamic view display settings to update"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view icon","description":"The dynamic view icon to update"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewIconType"},{"type":"null"}],"title":"The dynamic view icon type","description":"The dynamic view icon type to update"},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view sort","description":"The dynamic view sort to update (include '-' at beginning for descending)"},"is_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is locked","description":"If locked, other users cannot modify the dynamic view.","default":false},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is private","description":"If private, only the owner can see this dynamic view.","default":false},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["name","filters"],"title":"Body_update_drive_dynamic_view_route_dynamic_views__dynamic_view_id__put"},"AddedFilterForStorage":{"properties":{"id":{"title":"Id"},"options":{"items":{"$ref":"#/components/schemas/FilterOption"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"},"ignore_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Options"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForStorage"},"FilterOption":{"properties":{"client_val":{"type":"string","title":"Client Val"},"server_val":{"type":"string","title":"Server Val"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["client_val","server_val"],"title":"FilterOption"},"FilterClauseVal":{"type":"string","enum":["is","is any of","is not","is true","is false","is not true","is not false","has","doesn't have","before","after","between","is directly in","is under","is not in","<","< any of","<=","<= any of",">","> any of",">=",">= any of","hasn't started","in progress of","completed","failed","includes","does not include","contains","does not contain","does not start with","starts with","end with","is empty","is not empty"],"title":"FilterClauseVal","description":"Filter Clause Values Enum. Contains all filter clause values"},"DynamicViewDisplaySettings":{"properties":{"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"flatten_directories":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Flatten Directories"}},"type":"object","title":"DynamicViewDisplaySettings"},"DynamicViewIconType":{"type":"string","enum":["color","emoji","url"],"title":"DynamicViewIconType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## DELETE /dynamic-views/{dynamic\_view\_id}

> Delete Dynamic View Route

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/dynamic-views/{dynamic_view_id}":{"delete":{"tags":["faces"],"summary":"Delete Dynamic View Route","operationId":"delete_dynamic_view_route_dynamic_views__dynamic_view_id__delete","parameters":[{"name":"dynamic_view_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dynamic view id"}},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_delete_dynamic_view_route_dynamic_views__dynamic_view_id__delete"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_delete_dynamic_view_route_dynamic_views__dynamic_view_id__delete":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_delete_dynamic_view_route_dynamic_views__dynamic_view_id__delete"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /dynamic-views/{dynamic\_view\_id}/exports/{export\_format}

> Export dynamic view data

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/dynamic-views/{dynamic_view_id}/exports/{export_format}":{"get":{"tags":["faces"],"summary":"Export dynamic view data","operationId":"get_dynamic_view_exported_data_dynamic_views__dynamic_view_id__exports__export_format__get","parameters":[{"name":"dynamic_view_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dynamic view id"}},{"name":"export_format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ExportFormat","title":"The format"}},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"}},{"name":"os","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/OperatingSystem"},{"type":"null"}],"title":"The os to be exported to"}},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The timezone to be exported to (ex: 'America/New_York')"}},{"name":"password","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The password","description":"The password header to use to fetch the preview"},"description":"The password header to use to fetch the preview"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_dynamic_view_exported_data_dynamic_views__dynamic_view_id__exports__export_format__get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Dynamic View Exported Data Dynamic Views  Dynamic View Id  Exports  Export Format  Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ExportFormat":{"type":"string","enum":["csv","tsv","txt","ale","premiere","davinci","avid"],"title":"ExportFormat"},"OperatingSystem":{"type":"string","enum":["Windows","Linux","Debian","Fedora","Darwin"],"title":"OperatingSystem","description":"Operating System Enum from the result of platform.system()"},"Body_get_dynamic_view_exported_data_dynamic_views__dynamic_view_id__exports__export_format__get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_dynamic_view_exported_data_dynamic_views__dynamic_view_id__exports__export_format__get"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.shade.inc/developers/faces.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.