Skip to main content
POST
Detect providers on a business URL

Authorizations

Authorization
string
header
required

vine_live_… API key

Query Parameters

mode
enum<string>

Pass fresh to force a live scan at full price even when the service-side domain cache is enabled.

Available options:
fresh

Body

application/json
url
string<uri>
required

Business URL.

Example:

"https://www.mindbodyonline.com/explore/locations/the-sharp-barber"

callerRef
object

Response

Detected providers.

schemaVersion
string
detectionId
string

Stable handle for this detection run.

url
string
providers
string[]
discoveredProviders
object[]

Off-catalog vendors detected on the site that have no extraction adapter yet (informational).

durationMs
integer
creditsUsed
integer
creditBreakdown
object
cached
boolean

Present and true only when the service-side domain cache is enabled and serves a live detection for this domain from the last 7 days. Such responses return in ~1s and are billed at the flat cached rate. Absent on live scans; the cache is disabled by default. Pass ?mode=fresh to force a live scan even when it is enabled.

detectedAt
string<date-time>

When the underlying live scan ran (cached responses only).