POST /v1/data/web/brand-styleguide/run
Pricing: $0.0035 per style guide ($3.50 per 1,000).
Request
Send the inputs underparams. Only the keys below are accepted; any other key returns 422 invalid_params.
Example
curl -X POST "https://api.mindcase.co/v1/data/web/brand-styleguide/run?wait=true" \
-H "Authorization: Bearer $MINDCASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"params": {
"urls": [
"https://plausible.io",
"https://github.com",
"https://www.mercadolibre.com.ar"
]
}
}'
import os, requests
r = requests.post(
"https://api.mindcase.co/v1/data/web/brand-styleguide/run",
params={"wait": "true"},
headers={"Authorization": f"Bearer {os.environ['MINDCASE_API_KEY']}"},
json={"params": {
"urls": [
"https://plausible.io",
"https://github.com",
"https://www.mercadolibre.com.ar"
]
}},
)
job = r.json()
rows = job.get("data", []) # if job["status"] == "running", poll /v1/jobs/{job_id}/results
const r = await fetch("https://api.mindcase.co/v1/data/web/brand-styleguide/run?wait=true", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.MINDCASE_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ params: {
"urls": [
"https://plausible.io",
"https://github.com",
"https://www.mercadolibre.com.ar"
]
} }),
});
const job = await r.json();
const rows = job.data ?? []; // if job.status === "running", poll /v1/jobs/{job_id}/results
Response fields
Each row indata is one style guide, keyed by these fields.
| Field | Name | Type |
|---|---|---|
url | URL | url |
inputUrl | Input URL | url |
domain | Domain | text |
siteName | Site Name | text |
title | Title | text |
description | Description | text |
language | Language | text |
logoUrl | Logo URL | url |
logoSvg | Logo Svg | text |
logoCandidates | Logo Candidates | object_array |
faviconUrl | Favicon URL | url |
appleTouchIconUrl | Apple Touch Icon URL | url |
ogImageUrl | Og Image URL | url |
primaryColor | Primary Color | text |
secondaryColor | Secondary Color | text |
accentColor | Accent Color | text |
themeColor | Theme Color | text |
brandColors | Brand Colors | object_array |
neutralColors | Neutral Colors | object_array |
declaredColors | Declared Colors | object_array |
colorTokens | Color Tokens | object_array |
headingFont | Heading Font | text |
bodyFont | Body Font | text |
headingFontSource | Heading Font Source | text |
bodyFontSource | Body Font Source | text |
fonts | Fonts | object_array |
customFonts | Custom Fonts | array |
googleFonts | Google Fonts | array |
usesAdobeFonts | Uses Adobe Fonts | boolean |
fontFaces | Font Faces | object_array |
socialProfiles | Social Profiles | object_array |
manifest | Manifest | object |
Example response
Abridged: long text and lists are shortened.{
"job_id": "7f3a1c2e-0b9d-4c55-9a51-3f2e8d1b6a40",
"agent": "web/brand-styleguide",
"status": "completed",
"row_count": 1,
"truncated": false,
"data": [
{
"primaryColor": "#1a202c",
"logoUrl": "https://plausible.io/uploads/plausible-analytics-new-logo.png",
"declaredColors": [],
"customFonts": [],
"faviconUrl": "https://plausible.io/assets/images/icon/favicon.ico",
"logoCandidates": [
{
"url": "https://plausible.io/uploads/plausible-analytics-new-logo.png",
"source": "json-ld",
"ok": true,
"format": "webp",
"width": 1600,
"height": 900,
"bytes": 16384
},
{
"url": "https://plausible.io/assets/images/icon/plausible_logo.svg",
"source": "header-img",
"ok": true,
"format": "svg",
"width": null,
"height": null,
"bytes": null
}
],
"manifest": null,
"ogImageUrl": "https://plausible.io/assets/images/plausible_promo.jpg",
"themeColor": null,
"accentColor": "#5850ec",
"bodyFontSource": "system",
"appleTouchIconUrl": "https://plausible.io/assets/images/icon/apple-touch-icon.png",
"brandColors": [
{
"hex": "#1a202c",
"rgb": [
26,
32,
44
],
"hsl": [
220,
26,
14
],
"share": 0.1657,
"uses": 17.8,
"roles": [
"text",
"background"
],
"shades": 2,
"sources": [
"stylesheet"
]
},
{
"hex": "#b4c6fc",
"rgb": [
180,
198,
252
],
"hsl": [
225,
92,
85
],
"share": 0.0512,
"uses": 5.5,
"roles": [
"border",
"shadow",
"text"
],
"shades": 2,
"sources": [
"stylesheet"
]
}
],
"neutralColors": [
{
"hex": "#ffffff",
"rgb": [
255,
255,
255
],
"hsl": [
0,
0,
100
],
"share": 0.1024,
"uses": 11,
"roles": [
"text",
"background"
],
"shades": 2,
"sources": [
"stylesheet"
]
},
{
"hex": "#e5e7eb",
"rgb": [
229,
231,
235
],
"hsl": [
220,
13,
91
],
"share": 0.0745,
"uses": 8,
"roles": [
"border"
],
"shades": 2,
"sources": [
"stylesheet"
]
}
],
"language": "en",
"socialProfiles": [
{
"platform": "wikipedia",
"url": "https://en.wikipedia.org/wiki/Plausible_Analytics",
"source": "json-ld sameAs"
},
{
"platform": "wikidata",
"url": "https://www.wikidata.org/wiki/Q105731934",
"source": "json-ld sameAs"
}
],
"domain": "plausible.io",
"googleFonts": [],
"inputUrl": "https://plausible.io",
"headingFontSource": "system",
"logoSvg": null,
"description": "Plausible is a lightweight and open-source Google Analytics alternative. Your website data is 100% yours and the privacy of your visitors is respected.",
"fontFaces": [],
"url": "https://plausible.io",
"siteName": "Plausible Analytics"
}
]
}
Related APIs
For the page content useweb/scrape; for what the site says about the company use leads/company-research.