Skip to main content
POST
/
brand
/
ai
/
products
JavaScript
import BrandDev from 'brand.dev';

const client = new BrandDev({
  apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.brand.aiProducts({ domain: 'domain' });

console.log(response.products);
{
  "products": [
    {
      "name": "<string>",
      "description": "<string>",
      "features": [
        "<string>"
      ],
      "target_audience": [
        "<string>"
      ],
      "tags": [
        "<string>"
      ],
      "price": 123,
      "currency": "<string>",
      "billing_frequency": "monthly",
      "pricing_model": "per_seat",
      "url": "<string>",
      "category": "<string>",
      "image_url": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
domain
string
required

The domain name to analyze

maxProducts
integer

Maximum number of products to extract.

Required range: 1 <= x <= 12
timeoutMS
integer

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).

Required range: 1 <= x <= 300000

Response

Successful response

products
object[]

Array of products extracted from the website