Search
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.
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.
0Unified search results ranked by relevance
Unified search result DTO for simple search across all entity types
Type of entity: asset, collection, individual, view, or folder
ID of the entity (null for folders)
Display name of the entity
Path of the entity (for assets and folders)
Not found
Validation Error
POST /search/simple HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 159
{
"query": "text",
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"limit": 50,
"offset": 0,
"entity_types": [
"asset"
],
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}[
{
"entity_type": "asset",
"entity_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"path": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]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.
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
POST /search/simple/ranking HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"query": "text",
"entity_type": "asset",
"entity_id": "123e4567-e89b-12d3-a456-426614174000",
"path": "text",
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}No content
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.
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
POST /search/simple/ranking/reset HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"query": "text",
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}No content
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.
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
GET /search/simple/queries/recent?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}No content
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.
The password header to use to fetch the preview
The query to search for. If not provided, all assets will be returned.
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
POST /search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 357
{
"query": "text",
"filters": [
{
"id": null,
"options": [
"text"
],
"clause": "is"
}
],
"similar_asset_id": "123e4567-e89b-12d3-a456-426614174000",
"sort": "text",
"offset": 1,
"page": 1,
"limit": 100,
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"return_only_attrs": [
"text"
],
"collection_id": "123e4567-e89b-12d3-a456-426614174000",
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"path": "text",
"name": "text",
"extension": "text",
"updated": "2026-01-01T00:00:00.000Z",
"created": "2026-01-01T00:00:00.000Z",
"type": "IMAGE",
"size_bytes": 1,
"stack_id": "123e4567-e89b-12d3-a456-426614174000",
"stack_number": 1,
"is_fs_draft_blob": true,
"is_fs_null_blob": true,
"rating": 1,
"ai_indexed": true,
"system_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"custom_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"category": "text",
"palette": [
[
1
]
],
"ocr": "text",
"transcription_id": "123e4567-e89b-12d3-a456-426614174000",
"faces_present": true,
"content_length": 1,
"preview_job_state": "NOT_STARTED",
"metadata_job_state": "NOT_STARTED",
"core_vision_job_state": "NOT_STARTED",
"color_palette_job_state": "NOT_STARTED",
"core_audio_job_state": "NOT_STARTED",
"audio_job_state": "NOT_STARTED",
"facial_recognition_job_state": "NOT_STARTED",
"proxy_job_state": "NOT_STARTED",
"audio_proxy_job_state": "NOT_STARTED",
"transcription_job_state": "NOT_STARTED",
"objects": [],
"texture_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"integration_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"preview_images": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"frame": 1,
"signed_url": "text"
}
],
"custom_thumbnail": "text",
"proxy": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"audio_proxy": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
]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.
The password header to use to fetch the preview
The query to search for subclips.
The id of the drive we want to search on.
The database column signals to search through.
[]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
Asset DTO for chunk search results - includes preview images and proxy URLs.
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Enum for asset job states
Not found
Validation Error
POST /search/chunked HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 476
{
"query": "text",
"filters": [
{
"id": null,
"options": [
"text"
],
"clause": "is"
}
],
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"database_signals": [
"text"
],
"signal_weights": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"search_modes": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": true
}
},
"merge_chunks": true,
"video_score_threshold": 1,
"document_score_threshold": 1,
"image_score_threshold": 1,
"collection_id": "123e4567-e89b-12d3-a456-426614174000",
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"path": "text",
"name": "text",
"extension": "text",
"updated": "2026-01-01T00:00:00.000Z",
"created": "2026-01-01T00:00:00.000Z",
"type": "IMAGE",
"size_bytes": 1,
"stack_id": "123e4567-e89b-12d3-a456-426614174000",
"stack_number": 1,
"is_fs_draft_blob": true,
"is_fs_null_blob": true,
"rating": 1,
"ai_indexed": true,
"system_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"custom_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"category": "text",
"palette": [
[
1
]
],
"ocr": "text",
"transcription_id": "123e4567-e89b-12d3-a456-426614174000",
"faces_present": true,
"content_length": 1,
"preview_job_state": "NOT_STARTED",
"metadata_job_state": "NOT_STARTED",
"core_vision_job_state": "NOT_STARTED",
"color_palette_job_state": "NOT_STARTED",
"core_audio_job_state": "NOT_STARTED",
"audio_job_state": "NOT_STARTED",
"facial_recognition_job_state": "NOT_STARTED",
"proxy_job_state": "NOT_STARTED",
"audio_proxy_job_state": "NOT_STARTED",
"transcription_job_state": "NOT_STARTED",
"objects": [],
"texture_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"integration_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"preview_images": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"frame": 1,
"signed_url": "text"
}
],
"custom_thumbnail": "text",
"proxy": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"audio_proxy": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"relevant_chunks": []
}
]Get all content in a folder (non-indexed and indexed)
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
GET /search/folders?path=text&drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}[
"text"
]Get all files in a folder. This performs a "search" with a filter on the path, and auths on public paths.
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
100A 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
POST /search/files HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 331
{
"path": "text",
"recursive": false,
"query": "text",
"offset": 1,
"page": 1,
"limit": 100,
"filters": [
{
"id": null,
"options": [
"text"
],
"clause": "is"
}
],
"sort": "text",
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"return_only_attrs": [
"text"
],
"collection_id": "123e4567-e89b-12d3-a456-426614174000",
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"path": "text",
"name": "text",
"extension": "text",
"updated": "2026-01-01T00:00:00.000Z",
"created": "2026-01-01T00:00:00.000Z",
"type": "IMAGE",
"size_bytes": 1,
"stack_id": "123e4567-e89b-12d3-a456-426614174000",
"stack_number": 1,
"is_fs_draft_blob": true,
"is_fs_null_blob": true,
"rating": 1,
"ai_indexed": true,
"system_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"custom_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"category": "text",
"palette": [
[
1
]
],
"ocr": "text",
"transcription_id": "123e4567-e89b-12d3-a456-426614174000",
"faces_present": true,
"content_length": 1,
"preview_job_state": "NOT_STARTED",
"metadata_job_state": "NOT_STARTED",
"core_vision_job_state": "NOT_STARTED",
"color_palette_job_state": "NOT_STARTED",
"core_audio_job_state": "NOT_STARTED",
"audio_job_state": "NOT_STARTED",
"facial_recognition_job_state": "NOT_STARTED",
"proxy_job_state": "NOT_STARTED",
"audio_proxy_job_state": "NOT_STARTED",
"transcription_job_state": "NOT_STARTED",
"objects": [],
"texture_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"integration_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"preview_images": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"frame": 1,
"signed_url": "text"
}
],
"custom_thumbnail": "text",
"proxy": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"audio_proxy": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
]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.
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.
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.
A downloadable file
Not found
Validation Error
POST /search/exports/{export_format} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 401
{
"query": "text",
"filters": [
{
"id": null,
"options": [
"text"
],
"clause": "is"
}
],
"sort": "text",
"offset": 1,
"page": 1,
"limit": 100,
"drive_id": "123e4567-e89b-12d3-a456-426614174000",
"collection_id": "123e4567-e89b-12d3-a456-426614174000",
"path": "text",
"recursive": false,
"share_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata_attribute_ids": [
"text"
],
"os": "Windows",
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}No content
Last updated
Was this helpful?