docs / enrich-url

URL Intelligence API

base /enrich-url/v14 endpoints

post/enrich-url/v1/classify2 credits

Any URL → final_url, cleaned_url (tracking stripped), domain, entity_type{value,confidence,source}, platform, recommended{engine,action,params} (the Reef deep-fetch card; web-extract fallback for unknown hosts), tracking{affiliate,stripped_params}.

Parameter		Allowed / range	Description
url	required	—	Any http(s) URL — short/affiliate/tracking/canonical — or a bare host (stripe.com). Redirects are followed + tracking stripped by the inner url-resolver (SSRF-guarded). Private/internal targets are blocked there.
deep = false	optional	—	Advanced: when true, run an additional structured-data pass even when the page type was already identified, for deeper detail. Default false = fastest, most cost-efficient path.

Try in playground →

post/enrich-url/v1/extract_entity2 credits

Any URL → a lightweight entity card with title, image, description, price, author and publication date — great for link previews and deciding which Reef engine to call next. Use the recommended{} field from classify for the full deep-fetch.

Parameter		Allowed / range	Description
url	required	—	Any http(s) URL — short/affiliate/tracking/canonical — or a bare host (stripe.com). Redirects are followed + tracking stripped by the inner url-resolver (SSRF-guarded). Private/internal targets are blocked there.

Try in playground →

post/enrich-url/v1/batch2 credits

Classify up to 20 URLs in one call (the link-list cleanup + routing use-case): per-URL ok/error, each independently resolved + classified.

Parameter		Allowed / range	Description
urls	required	—	Up to 20 URLs (array or comma-separated). Each is resolved + classified independently; per-URL ok/error.

Try in playground →

post/enrich-url/v1/catalog_resolve1 credit

META (no network): given a known platform name OR a URL's host, return which Reef engine+action handles it and the param key it needs — the routing table itself (url-resolver marketplace engine_hints + the non-marketplace platform map). For agents discovering 'which engine for X'.

Parameter		Allowed / range	Description
platform	optional	—	A platform name (instagram/youtube/github/amazon/…) to resolve to its Reef engine+action. Omit both platform and url to list the full table.
url	optional	—	Optional URL whose host is mapped to its Reef engine (no network fetch — host-only routing lookup).

Try in playground →

Example request · classify

curl -X POST https://api.reefapi.com/enrich-url/v1/classify \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://www.amazon.com/dp/B08N5WRWNW?tag=aff-20&utm_source=x"}'

Response shape

{
  "ok": true,
  "data": { /* the result */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 12,
    "completeness_pct": 100
  },
  "error": null
}