# Web Brand Styleguide API

A website's brand style guide, with site name, title, description, language and the colors, fonts and logos it uses. Pass the URLs.

**Pricing:** $0.0035 per style guide

**Endpoint:** `POST /v1/data/web/brand-styleguide/run`

**Auth:** `Authorization: Bearer mk_live_...`

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | One or more urls. One request reads them all. |

## Example

`?wait=true` holds the request open until the run finishes (up to 60s) and returns the rows inline: one request, no polling.

```bash
curl -X POST "https://api.mindcase.co/v1/data/web/brand-styleguide/run?wait=true" \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"params":{"urls":["..."]}}'
```

```python
import requests

resp = requests.post(
    "https://api.mindcase.co/v1/data/web/brand-styleguide/run",
    params={"wait": "true"},
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={"params": {
    "urls": [
        "..."
    ]
}},
)
rows = resp.json()["data"]
```

## Longer runs

If the run is still going at the 60s ceiling you get back `{ job_id, status: "running" }` instead of rows (same if the result is over 100 rows; those come back `truncated`). Poll with that `job_id`:

```bash
# 1) check status
curl https://api.mindcase.co/v1/jobs/JOB_ID \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY"

# 2) when status == completed, fetch the rows
curl https://api.mindcase.co/v1/jobs/JOB_ID/results \
  -H "Authorization: Bearer mk_live_YOUR_API_KEY"
```

Full API reference (auth, jobs, balance, SDKs, MCP): https://mindcase.co/skills.md

## Response columns

| Field | Display 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 |