# Search

## Simple search for file names folders, collections, individuals, and views

> Unified simple search endpoint that searches across assets, folders, collections, individuals, and views.\
> \
> This endpoint provides a lightweight search that:\
> \- Searches assets by name\
> \- Searches folders by directory name\
> \- Searches collections by name\
> \- Searches individuals (face groups) by name\
> \- Searches dynamic views by name\
> \- Returns a unified list ranked by match quality (exact > prefix > contains > similarity)\
> \
> Unlike the main search endpoint, this does not perform AI-powered search or\
> semantic search. It's designed for fast, simple name-based lookups across\
> all searchable entities in the drive.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/simple":{"post":{"tags":["search","simple-search"],"summary":"Simple search for file names folders, collections, individuals, and views","description":"Unified simple search endpoint that searches across assets, folders, collections, individuals, and views.\n\nThis endpoint provides a lightweight search that:\n- Searches assets by name\n- Searches folders by directory name\n- Searches collections by name\n- Searches individuals (face groups) by name\n- Searches dynamic views by name\n- Returns a unified list ranked by match quality (exact > prefix > contains > similarity)\n\nUnlike the main search endpoint, this does not perform AI-powered search or\nsemantic search. It's designed for fast, simple name-based lookups across\nall searchable entities in the drive.","operationId":"simple_search_handler_search_simple_post","parameters":[{"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_simple_search_handler_search_simple_post"}}}},"responses":{"200":{"description":"Unified search results ranked by relevance","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleSearchResultDTO"},"title":"Response Simple Search Handler Search Simple Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_simple_search_handler_search_simple_post":{"properties":{"query":{"type":"string","title":"Search query","description":"The query to search for across all entity types."},"drive_id":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive to search in."},"limit":{"type":"integer","title":"Limit","description":"The maximum total number of results to return across all entity types. Defaults to 50.","default":50},"offset":{"type":"integer","title":"Offset","description":"The offset for pagination. Defaults to 0.","default":0},"entity_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/SearchEntity"},"type":"array"},{"type":"null"}],"title":"Entity types","description":"Optional list of entity types to search. If not provided, searches all types."},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["query","drive_id"],"title":"Body_simple_search_handler_search_simple_post"},"SearchEntity":{"type":"string","enum":["asset","folder","collection","individual","view"],"title":"SearchEntity","description":"Entity types that can be searched in simple search."},"SimpleSearchResultDTO":{"properties":{"entity_type":{"$ref":"#/components/schemas/SearchEntity","description":"Type of entity: asset, collection, individual, view, or folder"},"entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Entity Id","description":"ID of the entity (null for folders)"},"name":{"type":"string","title":"Name","description":"Display name of the entity"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Path of the entity (for assets and folders)"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Optional metadata for UI (e.g., drive_id, icon_type, icon)."}},"type":"object","required":["entity_type","entity_id","name"],"title":"SimpleSearchResultDTO","description":"Unified search result DTO for simple search across all entity types"},"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"}}}}
```

## Track a search result selection for personalized ranking

> Track when a user selects a search result to improve future search rankings.\
> \
> This endpoint records which search results users click on, allowing the system\
> to boost frequently selected results to the top of future searches for the same query.\
> \
> Requires authentication.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/simple/ranking":{"post":{"tags":["search","simple-search"],"summary":"Track a search result selection for personalized ranking","description":"Track when a user selects a search result to improve future search rankings.\n\nThis endpoint records which search results users click on, allowing the system\nto boost frequently selected results to the top of future searches for the same query.\n\nRequires authentication.","operationId":"track_search_selection_search_simple_ranking_post","parameters":[{"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_track_search_selection_search_simple_ranking_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_track_search_selection_search_simple_ranking_post":{"properties":{"query":{"type":"string","title":"Query","description":"The search query that was performed"},"entity_type":{"$ref":"#/components/schemas/SearchEntity","description":"Type of entity selected"},"entity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Entity Id","description":"ID of the selected entity (null for folders)"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Path of the selected entity (for folders)"},"drive_id":{"type":"string","format":"uuid","title":"Drive Id","description":"Drive where the search occurred"},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["query","entity_type","drive_id"],"title":"Body_track_search_selection_search_simple_ranking_post"},"SearchEntity":{"type":"string","enum":["asset","folder","collection","individual","view"],"title":"SearchEntity","description":"Entity types that can be searched in simple search."},"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"}}}}
```

## Reset personalized search rankings

> Reset personalized search ranking data for a user.\
> \
> If a query is provided, only rankings for that specific query are reset.\
> Otherwise, all search rankings for the user in the specified drive are reset.\
> \
> Requires authentication.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/simple/ranking/reset":{"post":{"tags":["search","simple-search"],"summary":"Reset personalized search rankings","description":"Reset personalized search ranking data for a user.\n\nIf a query is provided, only rankings for that specific query are reset.\nOtherwise, all search rankings for the user in the specified drive are reset.\n\nRequires authentication.","operationId":"reset_search_ranking_search_simple_ranking_reset_post","parameters":[{"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_reset_search_ranking_search_simple_ranking_reset_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_reset_search_ranking_search_simple_ranking_reset_post":{"properties":{"drive_id":{"type":"string","format":"uuid","title":"Drive Id","description":"Drive to reset rankings for"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Optional specific query to reset. If not provided, resets all queries."},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["drive_id"],"title":"Body_reset_search_ranking_search_simple_ranking_reset_post"},"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 recent unique search queries for the current user

> Get the most recent unique search queries for the current user.\
> \
> Returns queries ordered by the most recent selection time across any result\
> for that query. Useful for showing search history or suggested searches.\
> \
> Requires authentication.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/simple/queries/recent":{"get":{"tags":["search","simple-search"],"summary":"Get recent unique search queries for the current user","description":"Get the most recent unique search queries for the current user.\n\nReturns queries ordered by the most recent selection time across any result\nfor that query. Useful for showing search history or suggested searches.\n\nRequires authentication.","operationId":"get_recent_search_queries_search_simple_queries_recent_get","parameters":[{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive to get recent queries for"},"description":"The id of the drive to get recent queries for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","title":"Limit","description":"Maximum number of recent queries to return. Defaults to 10.","default":10},"description":"Maximum number of recent queries to return. Defaults to 10."},{"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_recent_search_queries_search_simple_queries_recent_get"}}}},"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_get_recent_search_queries_search_simple_queries_recent_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_recent_search_queries_search_simple_queries_recent_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"}}}}
```

## Search for assets. Note: This request is idempotent

> Search for assets in the database. This is the primary search function on assets.\
> \
> If collection\_id is provided, the search is restricted to that collection.\
> Otherwise, the search is performed on the entire drive.\
> \
> This route should not be called for searching on a public path - use /search/files instead.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search":{"post":{"tags":["search"],"summary":"Search for assets. Note: This request is idempotent","description":"Search for assets in the database. This is the primary search function on assets.\n\nIf collection_id is provided, the search is restricted to that collection.\nOtherwise, the search is performed on the entire drive.\n\nThis route should not be called for searching on a public path - use /search/files instead.","operationId":"search_search_post","parameters":[{"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_search_search_post"}}}},"responses":{"200":{"description":"A list of matching assets","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AssetDTO"},{"type":"object","additionalProperties":true}]},"title":"Response Search Search Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_search_search_post":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search query","description":"The query to search for. If not provided, all assets will be returned."},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForSearch"},"type":"array"},{"type":"null"}],"title":"Filters","description":"The filters that you want to apply to your search."},"similar_asset_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Similar asset id","description":"The id of the asset to find similar assets to."},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort order","description":"A field name, optionally prefixed by the - sign to specify a descending order."},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset","description":"The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted."},"page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page","description":"The page of results to return. Input either this or offset. Defaults to 0 if neither are inputted."},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"The maximum number of assets to return. Defaults to 100.","default":100},"drive_id":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive we want to search on."},"return_only_attrs":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Return only these attributes","description":"The attributes that you want to return. If not provided, all attributes will be returned. This is limited, and not all attributes that exist on AssetDTO will work.","default":[]},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"The collection id","description":"The id of the collection to search within."},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["drive_id"],"title":"Body_search_search_post"},"AddedFilterForSearch":{"properties":{"id":{"title":"Id"},"options":{"items":{"type":"string"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForSearch"},"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"},"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"}}}}
```

## Chunk enabled version of search above

> Search for subclips using columnar search engine. Returns assets with their associated chunks.\
> \
> If collection\_id is provided, the search is restricted to that collection.\
> Otherwise, the search is performed on the entire drive.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/chunked":{"post":{"tags":["search"],"summary":"Chunk enabled version of search above","description":"Search for subclips using columnar search engine. Returns assets with their associated chunks.\n\nIf collection_id is provided, the search is restricted to that collection.\nOtherwise, the search is performed on the entire drive.","operationId":"search_subclip_search_chunked_post","parameters":[{"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_search_subclip_search_chunked_post"}}}},"responses":{"200":{"description":"A list of matching assets with chunks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetWithChunkDTO"},"title":"Response Search Subclip Search Chunked Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_search_subclip_search_chunked_post":{"properties":{"query":{"type":"string","title":"Search query","description":"The query to search for subclips."},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForSearch"},"type":"array"},{"type":"null"}],"title":"Filters","description":"The filters that you want to apply to your search."},"drive_id":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive we want to search on."},"database_signals":{"items":{"type":"string"},"type":"array","title":"Database signals","description":"The database column signals to search through.","default":[]},"signal_weights":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Signal weights","description":"Weights for each database signal (e.g., {'video_chunks': 1.0, 'document_chunks': 0.8}). Default is 1.0 for all."},"search_modes":{"anyOf":[{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object"},{"type":"null"}],"title":"Search modes","description":"Search modes per signal. Each signal can have 'vector' and 'fulltext' modes enabled/disabled. E.g., {'video_chunks': {'vector': True, 'fulltext': False}, 'document_chunks': {'vector': True, 'fulltext': True}}. Default enables both modes where available."},"merge_chunks":{"type":"boolean","title":"Merge chunks","description":"Whether to merge overlapping/adjacent chunks within the same asset. Disable to see individual chunk segments.","default":true},"video_score_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Video score threshold","description":"Minimum score threshold for video/audio chunks. Chunks below this score are filtered out. Suggested: 0.03"},"document_score_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Document score threshold","description":"Minimum score threshold for document/transcription chunks. Chunks below this score are filtered out. Suggested: 0.35"},"image_score_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Image score threshold","description":"Minimum score threshold for image chunks. Chunks below this score are filtered out. Suggested: 0.02"},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"The collection id","description":"The id of the collection to search within."},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["query","drive_id"],"title":"Body_search_subclip_search_chunked_post"},"AddedFilterForSearch":{"properties":{"id":{"title":"Id"},"options":{"items":{"type":"string"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForSearch"},"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"},"AssetWithChunkDTO":{"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"}]},"relevant_chunks":{"items":{},"type":"array","title":"Relevant Chunks","default":[]}},"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":"AssetWithChunkDTO","description":"Asset DTO for chunk search results - includes preview images and proxy URLs."},"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 the folders in a folder

> Get all content in a folder (non-indexed and indexed)

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/folders":{"get":{"tags":["search"],"summary":"Get the folders in a folder","description":"Get all content in a folder (non-indexed and indexed)","operationId":"get_folders_in_a_folder_search_folders_get","parameters":[{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"The directory path","description":"The directory path to list items","format":"path"},"description":"The directory path to list items"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search query","description":"The query to search for. If not provided, all folder contents will be returned."},"description":"The query to search for. If not provided, all folder contents will be returned."},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset","description":"The offset of results to return. Input either this or 'page'."},"description":"The offset of results to return. Input either this or 'page'."},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page number","description":"The page to query. Input either this or 'offset'."},"description":"The page to query. Input either this or 'offset'."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit per page","description":"The limit that is fetched per page"},"description":"The limit that is fetched per page"},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive we want to add user to"},"description":"The id of the drive we want to add user to"},{"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_folders_in_a_folder_search_folders_get"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"path"},"title":"Response Get Folders In A Folder Search Folders Get"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_folders_in_a_folder_search_folders_get":{"properties":{"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","title":"Body_get_folders_in_a_folder_search_folders_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"}}}}
```

## Get the files in a folder

> Get all files in a folder. This performs a "search" with a filter on the path, and auths on public paths.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/files":{"post":{"tags":["search"],"summary":"Get the files in a folder","description":"Get all files in a folder. This performs a \"search\" with a filter on the path, and auths on public paths.","operationId":"get_files_in_a_folder_search_files_post","parameters":[{"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_get_files_in_a_folder_search_files_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AssetDTO"},{"type":"object","additionalProperties":true}]},"title":"Response Get Files In A Folder Search Files Post"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_get_files_in_a_folder_search_files_post":{"properties":{"path":{"type":"string","format":"path","title":"The directory path","description":"The directory path to list items"},"recursive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recursive search","description":"Whether or not to do a recursive search on the directory","default":false},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search query","description":"The query to search for. If not provided, all folder contents will be returned."},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset","description":"The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted."},"page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page number","description":"The page to query. Input either this or 'offset'. Defaults to 0 if neither are inputted."},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit per page","description":"The limit that is fetched per page. Defaults to 100","default":100},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForSearch"},"type":"array"},{"type":"null"}],"title":"Filters","description":"The filters that you want to apply to your search."},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort order","description":"A field name, optionally prefixed by the - sign to specify a descending order."},"drive_id":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive we want to add user to"},"return_only_attrs":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Return only these attributes","description":"The attributes that you want to return. If not provided, all attributes will be returned. This is limited, and not all attributes that exist on AssetDTO will work.","default":[]},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"The collection id","description":"The id of the collection (used for custom sort when browsing folders within a collection)."},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["path","drive_id"],"title":"Body_get_files_in_a_folder_search_files_post"},"AddedFilterForSearch":{"properties":{"id":{"title":"Id"},"options":{"items":{"type":"string"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForSearch"},"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"},"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"}}}}
```

## Export search results

> Export search results to a file. The file is returned as a downloadable response.\
> \
> If collection\_id is provided, the search is restricted to that collection.\
> If path is provided, the search is restricted to that path (includes public path).\
> Otherwise, the search is performed on the entire drive.

```json
{"openapi":"3.1.0","info":{"title":"shade","version":"dev"},"paths":{"/search/exports/{export_format}":{"post":{"tags":["search"],"summary":"Export search results","description":"Export search results to a file. The file is returned as a downloadable response.\n\nIf collection_id is provided, the search is restricted to that collection.\nIf path is provided, the search is restricted to that path (includes public path).\nOtherwise, the search is performed on the entire drive.","operationId":"export_search_route_search_exports__export_format__post","parameters":[{"name":"export_format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ExportFormat","title":"The format","description":"The format that you want to export the search results in."},"description":"The format that you want to export the search results in."},{"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":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_export_search_route_search_exports__export_format__post"}}}},"responses":{"200":{"description":"A downloadable file","content":{"application/json":{"schema":{"title":"Response Export Search Route Search Exports  Export Format  Post"}}}},"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"},"Body_export_search_route_search_exports__export_format__post":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search query","description":"The query to search for."},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForSearch"},"type":"array"},{"type":"null"}],"title":"Filters","description":"The filters that you want to apply to your search."},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort order","description":"A field name, optionally prefixed by the - sign to specify a descending order."},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset","description":"The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted."},"page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page number","description":"The page to query. Input either this or 'offset'. Defaults to 0 if neither are inputted."},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit per page","description":"The limit that is fetched per page. Defaults to 100","default":100},"drive_id":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive we want to search on."},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"The collection id","description":"The id of the collection to search within."},"path":{"anyOf":[{"type":"string","format":"path"},{"type":"null"}],"title":"The directory path","description":"The directory path to list items under"},"recursive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recursive search","description":"Whether or not to do a recursive search on the directory","default":false},"share_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"The share id","description":"The id of the share to search within"},"metadata_attribute_ids":{"items":{"type":"string"},"type":"array","title":"Attributes","description":"List of attribute IDs that should be returned (these are the columns in the export)"},"os":{"anyOf":[{"$ref":"#/components/schemas/OperatingSystem"},{"type":"null"}],"title":"The operating system","description":"The operating system that the exported file will be used on."},"body":{"additionalProperties":true,"type":"object","title":"Body","default":{}}},"type":"object","required":["drive_id","metadata_attribute_ids"],"title":"Body_export_search_route_search_exports__export_format__post"},"AddedFilterForSearch":{"properties":{"id":{"title":"Id"},"options":{"items":{"type":"string"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForSearch"},"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"},"OperatingSystem":{"type":"string","enum":["Windows","Linux","Debian","Fedora","Darwin"],"title":"OperatingSystem","description":"Operating System Enum from the result of platform.system()"},"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"}}}}
```