COcontext
Web Extraction

Scrape Styleguide

Changed on

Extract a comprehensive design system from a website including colors, typography, spacing, shadows, and UI components.

get/web/styleguide

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/web/styleguide
  • Auth
    HTTP bearer

Query parameters

domainstring

Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.

directUrlstring uri

A specific URL to fetch the styleguide from directly, bypassing domain resolution (e.g., 'https://example.com/design-system'). When provided, the styleguide is extracted from this exact URL. You must provide either 'domain' or 'directUrl', but not both.

maxAgeMsinteger nullable

Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 year.

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

colorScheme'light' | 'dark'

Optional browser color scheme to emulate for websites that respond to prefers-color-scheme. This value is part of the styleguide cache key.

tagsstring[]

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

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Successful response

statusstring

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

domainstring

The normalized domain that was processed

codeinteger

HTTP status code

Changes

  • 1febe5476266Revision changes
    • info

      added the required property to the response with the status

  • 24d2b91f5275Revision changes
    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

    • warning

      added the new WEBSITE_NOT_FOUND enum value to the response property for the response status