v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB

Web Extraction

Query website data using AI

Use AI to extract specific data points from a brand's website. The AI will crawl the website and extract the requested information based on the provided data points.

post/brand/ai/query

Request body

domainstring required

The domain name to analyze

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

{
  "data_to_extract": [
    {
      "datapoint_object_schema": {
        "testimonial_text": "string",
        "testimonial_author": "string"
      }
    }
  ],
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Successful response

statusstring

Status of the response, e.g., 'ok'

domainstring

The domain that was analyzed

urls_analyzedstring[]

List of URLs that were analyzed