Archive Asset (Custom Database)¶

Archive Asset¶

POST https://search.pex.com/api/v1/private/archive

Archives an asset from your private Custom Database catalog. Once archived, the asset (or the specified fingerprint types) will no longer be considered for matching during private searches.

Request¶

Accepts either application/json or application/x-www-form-urlencoded / multipart/form-data.

Field	Type	Required	Description
`provided_id`	string	Yes	Unique identifier of the asset to archive (also accepted as `id`).
`fingerprint_type`	array[string]	No	Specific fingerprint type(s) to archive (e.g., `["audio"]`). If omitted, all fingerprints associated with the asset are archived.

Examples¶

PythonBash

import requests

ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"

headers = {
    "Authorization": f"Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
}

# Archive all fingerprints for the asset
response = requests.post(
    "https://search.pex.com/api/v1/private/archive",
    headers=headers,
    json={
        "provided_id": "my-unique-asset-001",
    },
)

response.raise_for_status()

# Optionally archive only specific fingerprint types
# json={"provided_id": "my-unique-asset-001", "fingerprint_type": ["audio"]}

print(response.json())

ACCESS_TOKEN="YOUR_ACCESS_TOKEN"

# Archive all fingerprints for the asset
curl -X POST "https://search.pex.com/api/v1/private/archive" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "provided_id": "my-unique-asset-001"
  }'

Response¶

A successful archive request returns an empty JSON object with HTTP status 200.

JSON

{}