Search: Custom Database (Private Search)¶
The Search: Custom Database (Private Search) HTTP API allows you to manage and query your own private catalog of assets without needing to install the native SDK library in your runtime environment.
With these endpoints, you can:
- Ingest assets into your private catalog using media files or pre-generated fingerprints
- Perform asynchronous searches against your catalog using media files or pre-generated fingerprints
- Manage catalog entries by checking entry status, listing ingested assets, or archiving entries
Info
Note: In order to submit fingerprints directly rather than uploading full media files, you must use the pexsearch CLI tool to generate them. For more details on generating fingerprints, see the SDK CLI (pexsearch) documentation.
Endpoints Overview¶
| Method | Endpoint | Description |
|---|---|---|
POST |
/api/v1/private/start-search |
Start an asynchronous search against your private catalog |
GET |
/api/v1/private/check-search/{lookup_id} |
Retrieve results of a previously initiated search |
POST |
/api/v1/private/ingest |
Ingest a media file or fingerprint into your catalog |
POST |
/api/v1/private/archive |
Archive an asset or specific fingerprint types from your catalog |
GET |
/api/v1/private/get |
Retrieve metadata and status for a catalog entry |
GET |
/api/v1/private/list |
List catalog entries with cursor-based pagination |