API Documentation

Note: The Search APIs are currently in private testing and are not yet publicly available. If you are interested in additional information, please contact your Pex representative.

Overview

These endpoints provide REST access to Search workflows.

The API supports two ways to perform a search:

1. Use Case Search: the client provides a predefined use case (e.g. "identify music" or "find song usage") and the API handles the underlying Search configuration.

2. Advanced Search: the client explicitly provides fingerprint type and search type for more granular control and custom workflows.

Most search workflows are asynchronous:

1. The client starts a search (using either Use Case Search or Advanced Search)

2. The API returns a lookup_id.

3. The client requests the search result of that lookup_id.

4. The check endpoint blocks until the completed search response is available.