Search a knowledge store

The search query.

Narrows results to specific items in the knowledge store.

Filter by type of item (the asset_type field) or by specific identifiers (the item_id field). Use eq to match a single value or in to match any value in a list. When you specify multiple fields, the platform applies all conditions together.

Examples:

{
    "asset_type": {
        "eq": "video"
    }
}

{
    "asset_type": {
        "in": [
            "video"
        ]
    },
    "item_id": {
        "in": [
            "ksi_069e9870-3c4d-7abc-9012-3456789abcde"
        ]
    }
}

Omit the filter to search all items.

Specifies how videos are matched. Videos are the only type of item with configurable options, set in the search_options.video field. Images are always matched on their visual content and have no options to configure.

To choose which types of items to search, use the filter.asset_type field. Providing options in the search_options.video field when the filter.asset_type field excludes videos returns a 400 error.

If you omit this field, videos are matched on their visual content.

Search results, ordered by relevance.

Specifies how videos are matched. Videos are the only type of item with configurable options, set in the search_options.video field. Images are always matched on their visual content and have no options to configure.

To choose which types of items to search, use the filter.asset_type field. Providing options in the search_options.video field when the filter.asset_type field excludes videos returns a 400 error.

If you omit this field, videos are matched on their visual content.