Search

Search for assets. Note: This request is idempotent

post

Search for assets in the database. This is the primary search function and performs the visual search of your assets.

Body

queryany ofOptional

The query to search for. If not provided, all assets will be returned.

stringOptional

or

nullOptional

filtersany ofOptional

The filters that you want to apply to your search.

or

nullOptional

similar_asset_idany ofOptional

The id of the asset to find similar assets to.

string · uuidOptional

or

nullOptional

sortany ofOptional

A field name, optionally prefixed by the - sign to specify a descending order.

stringOptional

or

nullOptional

offsetany ofOptional

The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted.

integerOptional

or

nullOptional

pageany ofOptional

The page of results to return. Input either this or offset. Defaults to 0 if neither are inputted.

integerOptional

or

nullOptional

limitany ofOptional

The maximum number of assets to return. Defaults to 100.

Default: 100

integerOptional

or

nullOptional

drive_idstring · uuidRequired

The id of the drive we want to search on.

thresholdnumberOptional

The threshold that you want to give, decreasing it with increasing the limit will produce more results

Default: 0

return_only_attrsany ofOptional

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: []

string[]Optional

or

nullOptional

collection_idany ofOptional

The id of the collection to search within.

string · uuidOptional

or

nullOptional

Responses

200

A list of matching assets

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "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",
  "threshold": 0,
  "return_only_attrs": [
    "text"
  ],
  "collection_id": "123e4567-e89b-12d3-a456-426614174000"
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "name": "text",
    "extension": "text",
    "updated": "2025-08-11T14:39:11.061Z",
    "created": "2025-08-11T14:39:11.061Z",
    "type": "IMAGE",
    "signature": 1,
    "size_bytes": 1,
    "is_fs_draft_blob": true,
    "is_fs_null_blob": true,
    "rating": 1,
    "ai_indexed": true,
    "system_metadata": {},
    "custom_metadata": {},
    "preview_images": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "frame": 1
      }
    ],
    "proxy": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "audio_proxy": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "category": "text",
    "palette": [
      [
        1
      ]
    ],
    "ocr": "text",
    "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
    "faces_present": true,
    "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",
    "text_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": {},
    "integration_data": {}
  }
]

Get the folders in a folder

get

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

Query parameters

pathstring · pathRequired

The directory path to list items

queryany ofOptional

The query to search for. If not provided, all folder contents will be returned.

stringOptional

or

nullOptional

offsetany ofOptional

The offset of results to return. Input either this or 'page'.

integerOptional

or

nullOptional

pageany ofOptional

The page to query. Input either this or 'offset'.

integerOptional

or

nullOptional

limitany ofOptional

The limit that is fetched per page

integerOptional

or

nullOptional

drive_idstring · uuidRequired

The id of the drive we want to add user to

share_idany ofOptional

The id of the share to search within

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responsestring · path[]

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /search/folders?path=text&drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get the files in a folder

post

Get all files in a folder

Body

pathstring · pathRequired

The directory path to list items

recursiveany ofOptional

Whether or not to do a recursive search on the directory

Default: false

booleanOptional

or

nullOptional

queryany ofOptional

The query to search for. If not provided, all folder contents will be returned.

stringOptional

or

nullOptional

offsetany ofOptional

The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted.

integerOptional

or

nullOptional

pageany ofOptional

The page to query. Input either this or 'offset'. Defaults to 0 if neither are inputted.

integerOptional

or

nullOptional

limitany ofOptional

The limit that is fetched per page. Defaults to 100

Default: 100

integerOptional

or

nullOptional

filtersany ofOptional

The filters that you want to apply to your search.

or

nullOptional

sortany ofOptional

A field name, optionally prefixed by the - sign to specify a descending order.

stringOptional

or

nullOptional

thresholdnumberOptional

The threshold that you want to give, decreasing it with increasing the limit will produce more results

Default: 0.05

return_only_attrsany ofOptional

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: []

string[]Optional

or

nullOptional

drive_idstring · uuidRequired

The id of the drive we want to add user to

share_idany ofOptional

The id of the share to search within

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /search/files HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "path": "text",
  "recursive": false,
  "query": "text",
  "offset": 1,
  "page": 1,
  "limit": 100,
  "filters": [
    {
      "id": null,
      "options": [
        "text"
      ],
      "clause": "is"
    }
  ],
  "sort": "text",
  "threshold": 0.05,
  "return_only_attrs": [
    "text"
  ],
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "share_id": "123e4567-e89b-12d3-a456-426614174000"
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "drive_id": "123e4567-e89b-12d3-a456-426614174000",
    "path": "text",
    "name": "text",
    "extension": "text",
    "updated": "2025-08-11T14:39:11.061Z",
    "created": "2025-08-11T14:39:11.061Z",
    "type": "IMAGE",
    "signature": 1,
    "size_bytes": 1,
    "is_fs_draft_blob": true,
    "is_fs_null_blob": true,
    "rating": 1,
    "ai_indexed": true,
    "system_metadata": {},
    "custom_metadata": {},
    "preview_images": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "frame": 1
      }
    ],
    "proxy": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "audio_proxy": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "category": "text",
    "palette": [
      [
        1
      ]
    ],
    "ocr": "text",
    "transcription_id": "123e4567-e89b-12d3-a456-426614174000",
    "faces_present": true,
    "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",
    "text_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": {},
    "integration_data": {}
  }
]

Export search results

post

Path parameters

export_formatstring · enumRequired

The format that you want to export the search results in.

Possible values:

Body

queryany ofOptional

The query to search for.

stringOptional

or

nullOptional

filtersany ofOptional

The filters that you want to apply to your search.

or

nullOptional

sortany ofOptional

A field name, optionally prefixed by the - sign to specify a descending order.

stringOptional

or

nullOptional

offsetany ofOptional

The offset of results to return. Input either this or 'page'. Defaults to 0 if neither are inputted.

integerOptional

or

nullOptional

pageany ofOptional

The page to query. Input either this or 'offset'. Defaults to 0 if neither are inputted.

integerOptional

or

nullOptional

limitany ofOptional

The limit that is fetched per page. Defaults to 100

Default: 100

integerOptional

or

nullOptional

drive_idstring · uuidRequired

The id of the drive we want to search on.

metadata_attribute_idsstring[]Required

List of attribute IDs that should be returned (these are the columns in the export)

osany ofOptional

The operating system that the exported file will be used on.

string · enumOptional

Operating System Enum from the result of platform.system()

Possible values:

or

nullOptional

Responses

200

A downloadable file

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /search/exports/{export_format} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "query": "text",
  "filters": [
    {
      "id": null,
      "options": [
        "text"
      ],
      "clause": "is"
    }
  ],
  "sort": "text",
  "offset": 1,
  "page": 1,
  "limit": 100,
  "drive_id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata_attribute_ids": [
    "text"
  ],
  "os": "Windows"
}

No content