Brandohue API Documentation

curl -X POST https://api.brandohue.com/api/v1/extract \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://stripe.com"}'

# With caching enabled
curl -X POST https://api.brandohue.com/api/v1/extract \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://stripe.com", "useCache": true}'

# Custom color extraction options
curl -X POST https://api.brandohue.com/api/v1/extract \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://stripe.com",
    "extractLogoColors": true,
    "logoColorsLimit": 8,
    "extractScreenshotColors": true,
    "screenshotColorsLimit": 10,
    "extractHtmlColors": true,
    "extractCssColors": true,
    "extractJsColors": false,
    "hexColor": false
  }'

# With callback URL (async)
curl -X POST https://api.brandohue.com/api/v1/extract \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://stripe.com", "callbackUrl": "https://your-app.com/webhook"}'

const response = await fetch(
  'https://api.brandohue.com/api/v1/extract',
  {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      url: 'https://stripe.com',
      useCache: false,
      extractLogoColors: true,
      logoColorsLimit: 6,
      extractScreenshotColors: true,
      screenshotColorsLimit: 12,
      extractHtmlColors: true,
      extractCssColors: true,
      extractJsColors: false,
      hexColor: false,
    }),
  }
);

const result = await response.json();

if (response.ok) {
  console.log('Logo:', result.data.logoUrl);
  console.log('Colors:', result.data.colors);
  console.log('Nearest colors:', result.data.nearestColors);
  console.log('Visual palette:', result.data.visualPalette);
  console.log('Credits left:', result.billing.newBalance);
} else {
  console.error('Error:', result.error);
}

// Send extraction request with callback URL
const response = await fetch(
  'https://api.brandohue.com/api/v1/extract',
  {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      url: 'https://stripe.com',
      callbackUrl: 'https://your-app.com/webhook',
    }),
  }
);

const result = await response.json();
// { status: "processing", message: "Extraction started..." }

// Your webhook endpoint receives:
// POST /webhook
// { status: "completed", data: {...}, billing: {...} }
// or
// { status: "failed", error: "...", detail: "..." }

import requests

response = requests.post(
    'https://api.brandohue.com/api/v1/extract',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'url': 'https://stripe.com',
        'useCache': False,
        'extractLogoColors': True,
        'logoColorsLimit': 6,
        'extractScreenshotColors': True,
        'screenshotColorsLimit': 12,
        'extractHtmlColors': True,
        'extractCssColors': True,
        'extractJsColors': False,
        'hexColor': False,
    },
)

data = response.json()

if response.status_code == 200:
    print(f"Logo: {data['data']['logoUrl']}")
    print(f"Colors: {data['data']['colors']}")
    print(f"Nearest colors: {data['data']['nearestColors']}")
    print(f"Visual palette: {data['data']['visualPalette']}")
    print(f"Credits left: {data['billing']['newBalance']}")
else:
    print(f"Error: {data['error']}")

import requests

response = requests.post(
    'https://api.brandohue.com/api/v1/extract',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'url': 'https://stripe.com',
        'callbackUrl': 'https://your-app.com/webhook',
    },
)

data = response.json()
# { "status": "processing", "message": "Extraction started..." }
print(data['status'])  # "processing"

# Your webhook endpoint receives:
# POST /webhook
# { "status": "completed", "data": {...}, "billing": {...} }
# or
# { "status": "failed", "error": "...", "detail": "..." }

const axios = require('axios');

async function extractBrand(url) {
  try {
    const { data } = await axios.post(
      'https://api.brandohue.com/api/v1/extract',
      {
        url,
        extractLogoColors: true,
        logoColorsLimit: 6,
        extractScreenshotColors: true,
        screenshotColorsLimit: 12,
        extractHtmlColors: true,
        extractCssColors: true,
        extractJsColors: false,
      },
      {
        headers: {
          'x-api-key': process.env.BRANDOHUE_API_KEY,
          'Content-Type': 'application/json',
        },
      }
    );

    console.log(data.data.colors);
    console.log(data.data.nearestColors);
    console.log(data.data.visualPalette);
    return data;
  } catch (error) {
    if (error.response?.status === 402) {
      console.error('Insufficient credits');
    }
    throw error;
  }
}

extractBrand('https://stripe.com');

const axios = require('axios');

async function extractWithCallback(url, callbackUrl) {
  const { data } = await axios.post(
    'https://api.brandohue.com/api/v1/extract',
    { url, callbackUrl },
    {
      headers: {
        'x-api-key': process.env.BRANDOHUE_API_KEY,
        'Content-Type': 'application/json',
      },
    }
  );
  // { status: "processing", message: "Extraction started..." }
  console.log(data.status); // "processing"
}

extractWithCallback('https://stripe.com', 'https://your-app.com/webhook');

// Your webhook endpoint receives:
// POST /webhook
// { status: "completed", data: {...}, billing: {...} }
// or
// { status: "failed", error: "...", detail: "..." }