Search
The password header to use to fetch the preview
The query to search for across all entity types.
The id of the drive to search in.
The maximum total number of results to return across all entity types. Defaults to 50.
50The offset for pagination. Defaults to 0.
0Optional list of entity types to search. If not provided, searches all types.
Unified search results ranked by relevance
Not found
Validation Error
The password header to use to fetch the preview
The search query that was performed
Type of entity selected
ID of the selected entity (null for folders)
Path of the selected entity (for folders)
Drive where the search occurred
Successful Response
Not found
Validation Error
No content
The password header to use to fetch the preview
Drive to reset rankings for
Optional specific query to reset. If not provided, resets all queries.
Successful Response
Not found
Validation Error
No content
The id of the drive to get recent queries for
Maximum number of recent queries to return. Defaults to 10.
10The password header to use to fetch the preview
Successful Response
Not found
Validation Error
No content
The password header to use to fetch the preview
The query to search for. If not provided, all assets will be returned.
The filters that you want to apply to your search.
The id of the asset to find similar assets to.
A field name, optionally prefixed by the - sign to specify a descending order.
The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted.
The page of results to return. Input either this or offset. Defaults to 0 if neither are inputted.
The maximum number of assets to return. Defaults to 100.
100The id of the drive we want to search on.
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.
[]The id of the collection to search within.
A list of matching assets
Not found
Validation Error
The password header to use to fetch the preview
The query to search for subclips.
The filters that you want to apply to your search.
The id of the drive we want to search on.
The database column signals to search through.
[]Weights for each database signal (e.g., {'video_chunks': 1.0, 'document_chunks': 0.8}). Default is 1.0 for all.
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.
Whether to merge overlapping/adjacent chunks within the same asset. Disable to see individual chunk segments.
trueMinimum score threshold for video/audio chunks. Chunks below this score are filtered out. Suggested: 0.03
Minimum score threshold for document/transcription chunks. Chunks below this score are filtered out. Suggested: 0.35
Minimum score threshold for image chunks. Chunks below this score are filtered out. Suggested: 0.02
The id of the collection to search within.
A list of matching assets with chunks
Not found
Validation Error
The directory path to list items
The query to search for. If not provided, all folder contents will be returned.
The offset of results to return. Input either this or 'page'.
The page to query. Input either this or 'offset'.
The limit that is fetched per page
The id of the drive we want to add user to
The password header to use to fetch the preview
Successful Response
Not found
Validation Error
The password header to use to fetch the preview
The directory path to list items
Whether or not to do a recursive search on the directory
falseThe query to search for. If not provided, all folder contents will be returned.
The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted.
The page to query. Input either this or 'offset'. Defaults to 0 if neither are inputted.
The limit that is fetched per page. Defaults to 100
100The filters that you want to apply to your search.
A field name, optionally prefixed by the - sign to specify a descending order.
The id of the drive we want to add user to
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.
[]The id of the collection (used for custom sort when browsing folders within a collection).
Successful Response
Not found
Validation Error
The format that you want to export the search results in.
The password header to use to fetch the preview
The query to search for.
The filters that you want to apply to your search.
A field name, optionally prefixed by the - sign to specify a descending order.
The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted.
The page to query. Input either this or 'offset'. Defaults to 0 if neither are inputted.
The limit that is fetched per page. Defaults to 100
100The id of the drive we want to search on.
The id of the collection to search within.
The directory path to list items under
Whether or not to do a recursive search on the directory
falseThe id of the share to search within
List of attribute IDs that should be returned (these are the columns in the export)
The operating system that the exported file will be used on.
Operating System Enum from the result of platform.system()
A downloadable file
Not found
Validation Error
No content
Last updated