Extract design system and styleguide from website

Automatically extract comprehensive design system information from a brand’s website including colors, typography, spacing, shadows, and UI components. Either ‘domain’ or ‘directUrl’ must be provided as a query parameter, but not both.

GET /brand/styleguide

JavaScript

JavaScript

import ContextDev from 'context.dev';

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

const response = await client.style.extractStyleguide();

console.log(response.styleguide);

200

{
  "status": "<string>",
  "domain": "<string>",
  "code": 123
}

Authorizations

Authorization · string · header · required

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

Query Parameters

domain · string

Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.

directUrl · string<uri>

A specific URL to fetch the styleguide from directly, bypassing domain resolution (e.g., 'https://example.com/design-system').

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: 1000 <= x <= 300000

Response

200

application/json

Successful response

status · string

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

domain · string

The normalized domain that was processed

styleguide · object

Comprehensive styleguide data extracted from the website

Show child attributes

code · integer

HTTP status code