Search Assets

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

Response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "user_description": "string",
    "description": "string",
    "signature": 0,
    "updated": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "file_created": "2019-08-24T14:15:22Z",
    "file_modified": "2019-08-24T14:15:22Z",
    "timestamp": 0,
    "path": "string",
    "type": "IMAGE",
    "tags": [
      "string"
    ],
    "size_bytes": 0,
    "source": [
      "string"
    ],
    "objects": [
      null
    ],
    "transcription": "string",
    "rating": 0,
    "blurhash": "string",
    "palette": [
      [
        0
      ]
    ],
    "ocr": "string",
    "category": "string",
    "extension": "string",
    "license": "cc-by",
    "asset_metadata": {},
    "preview_images": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "path": "string",
        "thumbnail": "string",
        "created": "2019-08-24T14:15:22Z"
      }
    ],
    "texture_data": {},
    "integration_data": {},
    "proxy_path": "string",
    "ai_indexed": true,
    "comments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "content": "string",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "candid": true,
    "faces_present": true,
    "red_eye": true,
    "eyes_open": true,
    "people_posing": true,
    "blurry": true,
    "focused": true,
    "good_exposure": true,
    "players": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "number": 0,
        "image_blob": "string"
      }
    ]
  }
]

Query Parameters

query · string

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

collection_ids[] · string<uuid>[]

The collection ids to search in. If not provided, all collection ids will be searched.

projects[] · string[]

The project to search in. If not provided, all projects will be searched.

people[] · string[]

The people to search for. If not provided, all people will be searched.

file_types[] · string[]

The file types to search for. If not provided, all file types will be searched.

file_extensions[] · string[]

The file extensions to search for. If not provided, all file extensions will be searched.

tags[] · string[]

The tags to search for. If not provided, all tags will be searched.

resolutions[] · string[]

The resolution to search for, in the format WxH (e.g. 1920x1080). If not provided, all resolutions will be searched.

limit · integer · default: 100

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

page · integer · default: 0

The page of results to return. Defaults to 0.

color · string

The color to search for. Cannot be used with the query parameter.

asset_rating · integer

The asset rating to filter for.

folder · string

The folder to filter for.

recursive · boolean · default: false

True to recursively search folder

filter_ai · boolean · default: false

Filter to only search assets that have been indexed with AI

categories[] · string[]

The categories to search and filter on

keys[] · string[]

The audio keys to search for (C, C#, etc). If not provided, all keys will be searched.

audio_types[] · string[]

The audio types (one-shots and loops) to filter on

bpm[] · integer[]

Exact match on one BPM or range if two numbers are given

date_added[] · string[]

List of two dates between which we return the assets

sort · string

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

use_pca · boolean · default: false

Used on the discover page to group assets by embeddings.

exclude_file_types[] · string[]

Used by pages that want to exclude certain types of assets

candid · boolean

Whether to use candid or not

red_eye · boolean

Whether to use red eye or not

faces_present · boolean

Whether to use faces present or not

people_posing · boolean

Whether to use people posing or not

eyes_open · boolean

Whether to use eyes open or not

blurry · boolean

Whether to use blurry or not

focused · boolean

Whether to use focused or not

good_exposure · boolean

Whether to use good exposure or not

Response

200

application/json

A list of matching assets

The response is of type AssetModel · object[].