Skip to content

Get Catalog Entry (Custom Database)

Get Catalog Entry Details

GET https://search.pex.com/api/v1/private/get

Retrieves metadata, ingestion status, and associated fingerprint types for an existing catalog entry using its provided ID.

Request

Query Parameter Type Required Description
provided_id string Yes Unique identifier of the catalog entry to retrieve (also accepted as id).

Examples

import requests

ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"
PROVIDED_ID = "my-unique-asset-001"

response = requests.get(
    "https://search.pex.com/api/v1/private/get",
    headers={
        "Authorization": f"Bearer {ACCESS_TOKEN}",
    },
    params={
        "provided_id": PROVIDED_ID,
    },
)

response.raise_for_status()

print(response.json())

ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
PROVIDED_ID="my-unique-asset-001"

curl -X GET "https://search.pex.com/api/v1/private/get?provided_id=${PROVIDED_ID}" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}"

Response

A successful request returns the entry's metadata and ingestion status.

{
  "provided_id": "my-unique-asset-001",
  "status": 1,
  "fingerprint_types": [
    1
  ]
}

Field Definitions

Field Type Description
provided_id string Identifier assigned to the asset during ingestion.
status integer Ingestion status of the entry (1 = Ready).
fingerprint_types array[integer] List of integer codes representing generated fingerprint signals (1 = Audio, 2 = Video, 3 = Melody, 4 = Phonetic).