Sign in
OpenAPI 3.1.02026-08-1979149857.1 KB

d63b1aad8ff3

Web Extraction

Extract a single product from a URL

Given a single URL, determines if it is a product page and extracts the product information.

post/brand/ai/product

Request body

urlstring uri required

The product page URL to extract product data from.

maxAgeMsinteger

Return a cached result if a prior scrape for the same parameters exists and is younger than this many milliseconds. Defaults to 7 days (604800000 ms) when omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.

timeoutMSinteger

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Example request

{
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Successful response

is_product_pageboolean

Whether the given URL is a product detail page

platform'amazon' | 'tiktok_shop' | 'etsy' | 'generic' | 'null' nullable

The detected ecommerce platform, or null if not a product page