Search catalog assets

POST 
/catalog/search

Searches across catalog data sources and returns the assets associated with each. Despite being a POST, this operation takes no request body: every input is a query parameter, and any body sent is ignored.

Two search modes are available via search_type. "traditional" does keyword matching over the fields named in FieldsToMatch. "semantic" does embedding-based matching, requires a non-empty query, requires AI services to be enabled, and returns extra per-asset attributes.

Setting get_metrics=true changes the response shape entirely: it returns only facet counts and total_count, with no Results array and no pagination keys. Use it to populate filter controls, then run the real search separately.

Filtering: any query parameter that is not one of the documented system parameters is treated as a filter on the catalog field of that exact name, with comma-separated values. Filter values are lower-cased before matching, except for FieldsToMatch. There is no allow-list, so a misspelled filter name silently matches nothing rather than erroring.

Pagination: paging is by page_number, which is zero-based, combined with limit as the page size. Read next_available in the response; while it is "yes" increment page_number, and stop when it is "no". total_pages is also returned. Note that the offset parameter is validated but has no effect.

Request

Responses

200

Search results. The body is CatalogSearchResponse normally, or CatalogSearchMetricsResponse when get_metrics=true. When the request sends Accept-Encoding: gzip the body is gzip-compressed and base64-encoded.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers
Content-Encoding

Set to "gzip" when the request asked for compression.

400

Input validation, authorization, or unavailable-feature failure. Body is {"Message": " - "}. Codes: IPV-1071 (invalid search_type, time_field or access_level), IPV-1052 (semantic search with an empty query), IPV-1068 (query longer than 255 characters), IPV-1004 (limit, page_number or offset is not a non-negative integer), IPV-1050 (limit above 5000), IPV-1056 (start_time or end_time is not in "YYYY-MM-DD HH:MM:SS" form), IPV-1036 (start_time later than end_time), AI-1005 / AI-1007 (semantic search requested where AI services or catalog AI search are not enabled), AUTH-1001 (role_id header missing).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Backend failure. The most common cause is the search backend being unavailable or the catalog index being rebuilt, reported as GE-1004. Body is {"Message": " - "}.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers