BrandparserInvite Only
Brands

Get brand details

Retrieve detailed brand information including analysis results when available.

GET
/v1/api/brands/{brandId}
AuthorizationBearer <token>

API key with bp_prod_ or bp_stag_ prefix

In: header

Path Parameters

brandId*string

The unique identifier of the brand

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.brandparser.com/v1/api/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "source_url": "http://example.com",
    "favicon_url": "string",
    "analysis_status": "idle",
    "analysis_started_at": "2019-08-24T14:15:22Z",
    "analysis_completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "assets_expire_at": "2019-08-24T14:15:22Z",
    "assets_expired": true,
    "queue_position": 0,
    "estimated_wait_minutes": 0,
    "has_overrides": true,
    "overridden_sections": [
      "colors"
    ],
    "requested_stages": [
      "string"
    ],
    "resolved_stages": [
      "string"
    ],
    "max_pages": 0,
    "quality_note": "string",
    "cache_ttl": 0,
    "analysis": {
      "things": {
        "name": "Brandparser",
        "description": "Brandparser is an AI-powered platform that extracts brand guidelines from any public website.",
        "purpose": "string",
        "capabilities": [
          "string"
        ],
        "category": "string"
      },
      "mission": {
        "mission_statement": {
          "statement": "string",
          "explanation": "string"
        },
        "vision": {
          "statement": "string",
          "explanation": "string"
        },
        "core_values": [
          {
            "title": "string",
            "description": "string",
            "icon_type": "target"
          }
        ],
        "brand_promise": {
          "title": "string",
          "description": "string",
          "usage_context": [
            "string"
          ],
          "icon_type": "string"
        }
      },
      "audiences": {
        "personas": [
          {
            "name": "string",
            "gender": "woman",
            "ethnicity": "string",
            "role": "string",
            "challenge": "string",
            "industry": "string",
            "business_context": "string",
            "goals": "string",
            "pain_points": "string",
            "image_path": "string"
          }
        ]
      },
      "tone": {
        "voice_traits": [
          {
            "name": "string",
            "correct_example": "string",
            "incorrect_example": "string",
            "explanation": "string"
          }
        ],
        "example_phrases": {
          "we_say": [
            "string"
          ],
          "we_dont_say": [
            "string"
          ]
        },
        "style_guidelines": [
          {
            "category": "string",
            "rule": "string",
            "example": "string"
          }
        ],
        "voice_summary": "string",
        "llm_prompts": {
          "system_prompt": "string",
          "writing_instructions": "string",
          "quick_reference": "string"
        }
      },
      "logos": {
        "slots": {
          "mark_light": {
            "asset_path": "brands/abc/mark-light.svg",
            "format": "svg",
            "is_vector": true,
            "width": null,
            "height": null
          },
          "mark_dark": {
            "asset_path": "brands/abc/mark-dark.svg",
            "format": "svg",
            "is_vector": true,
            "width": null,
            "height": null,
            "generated": true
          },
          "wordmark_light": {
            "asset_path": "brands/abc/wordmark.svg",
            "format": "svg",
            "is_vector": true,
            "width": null,
            "height": null
          },
          "wordmark_dark": null
        },
        "slot_definitions": [
          {
            "key": "mark_light",
            "label": "string",
            "description": "string"
          }
        ],
        "primary_logo": null,
        "variants": [
          null
        ],
        "favicon": null
      },
      "colors": {
        "primary_palette": [
          {
            "name": "string",
            "hex": "#1a2b3c",
            "rgba": "string",
            "hsl": "string",
            "usage": "string",
            "category": "primary",
            "usage_frequency": 0,
            "contexts": [
              "string"
            ],
            "is_gradient": true,
            "gradient_definition": "string",
            "recommended_usage_percent": "string"
          }
        ],
        "button_colors": [
          {
            "label": "string",
            "background_hex": "string",
            "background_rgba": "string",
            "text_hex": "string",
            "text_rgba": "string",
            "border_hex": "string",
            "border_rgba": "string",
            "hover_background_hex": "string",
            "hover_background_rgba": "string",
            "usage": "string",
            "accessibility": {
              "contrast_ratio": 0,
              "wcag_aa": true,
              "wcag_aaa": true,
              "wcag_large_text_aa": true
            }
          }
        ],
        "supporting_colors": [
          {
            "name": "string",
            "hex": "string",
            "rgba": "string",
            "hsl": "string",
            "usage": "string"
          }
        ],
        "color_pairings": [
          {
            "foreground_hex": "string",
            "background_hex": "string",
            "usage": "string",
            "accessibility": {
              "contrast_ratio": 0,
              "wcag_aa": true,
              "wcag_aaa": true,
              "wcag_large_text_aa": true
            },
            "recommended": true
          }
        ],
        "dark_mode": {
          "detected": "yes",
          "generated": true,
          "dark_mode_colors": [
            {
              "name": "string",
              "hex": "string",
              "rgba": "string",
              "hsl": "string",
              "usage": "string",
              "light_mode_equivalent": "string"
            }
          ]
        },
        "usage_guidelines": [
          "string"
        ],
        "design_notes": "string",
        "accessibility": {
          "overall_score": "good",
          "recommendations": [
            "string"
          ],
          "contrast_issues": [
            {
              "type": "string",
              "element": "string",
              "foreground_hex": "string",
              "background_hex": "string",
              "contrast_ratio": 0,
              "meets_wcag_aa": true,
              "recommendation": "string"
            }
          ]
        }
      },
      "typography": {
        "font_families": [
          {
            "name": "string",
            "usage": "string",
            "availability": {
              "availability": "system",
              "requires_license": true,
              "foundry": "string",
              "license_type": "string",
              "recommended_alternative": "string",
              "alternative_rationale": "string",
              "notes": "string",
              "google_fonts_css_url": "string",
              "bunny_fonts_css_url": "string"
            }
          }
        ],
        "headings": [
          {
            "level": "hero",
            "label": "string",
            "font_size": "52px",
            "font_weight": "700",
            "line_height": "1.2",
            "letter_spacing": "string",
            "example_text_color": "string",
            "example_background_color": "string",
            "text_transform": "none",
            "special_effects": "string",
            "usage": "string"
          }
        ],
        "labels": [
          {
            "label": "string",
            "font_size": "string",
            "font_weight": "string",
            "text_transform": "string",
            "letter_spacing": "string",
            "example_text_color": "string",
            "usage": "string"
          }
        ],
        "body_text": [
          {
            "label": "string",
            "font_size": "string",
            "font_weight": "string",
            "line_height": "string",
            "example_text_color": "string",
            "usage": "string"
          }
        ],
        "links": [
          {
            "label": "string",
            "font_size": "string",
            "font_weight": "string",
            "text_decoration": "string",
            "hover_color": "string",
            "example_text_color": "string",
            "usage": "string"
          }
        ],
        "buttons": [
          {
            "label": "string",
            "font_size": "string",
            "font_weight": "string",
            "background_color": "string",
            "padding": "string",
            "border_radius": "string",
            "border": "string",
            "hover_background": "string",
            "example_text_color": "string",
            "usage": "string"
          }
        ],
        "blockquotes": [
          {
            "label": "string",
            "font_size": "string",
            "font_weight": "string",
            "line_height": "string",
            "font_style": "normal",
            "border_left": "string",
            "padding": "string",
            "example_text_color": "string",
            "usage": "string"
          }
        ],
        "design_notes": "string"
      },
      "images": {
        "summary": {
          "overall_mood": {
            "keywords": [
              "string"
            ],
            "description": "string"
          }
        },
        "photographic_style": {
          "subjects": {
            "primary": [
              "string"
            ],
            "secondary": [
              "string"
            ]
          },
          "composition": {
            "framing": [
              "string"
            ],
            "camera_angles": [
              "string"
            ],
            "layout": [
              "string"
            ],
            "notes": "string"
          },
          "lighting_and_color": {
            "lighting": [
              "string"
            ],
            "contrast": "low",
            "palette_relation_to_brand_colors": "string",
            "notes": "string"
          },
          "people_and_characters": {
            "diversity_notes": "string",
            "styling": [
              "string"
            ],
            "emotional_tone": [
              "string"
            ]
          },
          "backgrounds_and_environments": {
            "types": [
              "string"
            ],
            "depth_of_field": "string",
            "use_of_gradients_or_textures": "string"
          },
          "examples": [
            {
              "role": "string",
              "description": "string",
              "page_context": "string"
            }
          ]
        },
        "illustration_style": {
          "style_keywords": [
            "string"
          ],
          "technique": "string",
          "color_usage": "string",
          "line_and_shape_language": "string",
          "character_design": "string",
          "examples": [
            {
              "role": "string",
              "description": "string",
              "page_context": "string"
            }
          ]
        },
        "icon_style": {
          "visual_style": {
            "stroke_vs_fill": "string",
            "stroke_weight": "string",
            "corner_radius": "string",
            "metaphor_style": [
              "string"
            ],
            "consistency_notes": "string"
          },
          "usage_contexts": [
            "string"
          ],
          "possible_library": {
            "name": "string",
            "notes": "string"
          },
          "examples": [
            {
              "role": "string",
              "description": "string",
              "page_context": "string"
            }
          ]
        },
        "product_imagery": {
          "ui_screenshots": {
            "layout_and_chrome": [
              "string"
            ],
            "backgrounds": [
              "string"
            ],
            "color_and_mood": [
              "string"
            ],
            "accent_details": [
              "string"
            ],
            "composition": [
              "string"
            ],
            "avoid": [
              "string"
            ],
            "examples": [
              {
                "role": "string",
                "description": "string",
                "page_context": "string"
              }
            ]
          },
          "code_snippet_style": {
            "editor_treatment": [
              "string"
            ],
            "syntax_colors": [
              "string"
            ],
            "language_or_content": [
              "string"
            ],
            "avoid": [
              "string"
            ],
            "examples": [
              {
                "role": "string",
                "description": "string",
                "page_context": "string"
              }
            ]
          }
        },
        "assets": {
          "images": [
            {
              "url": "string",
              "r2_key": "string",
              "role": "string",
              "description": "string",
              "alt": "string",
              "classes": "string",
              "library_guess": "string",
              "page_url": "string"
            }
          ],
          "icons": [
            {
              "url": "string",
              "r2_key": "string",
              "role": "string",
              "description": "string",
              "alt": "string",
              "classes": "string",
              "library_guess": "string",
              "page_url": "string"
            }
          ]
        }
      },
      "art-direction": {
        "aesthetic_language": {
          "style_descriptors": [
            {
              "name": "string",
              "means": "string",
              "avoids": "string"
            }
          ],
          "overall_aesthetic": "string"
        },
        "visual_guidelines": {
          "guidelines_summary": "string",
          "guidelines": [
            {
              "name": "string",
              "guideline": "string",
              "applies_to": "string",
              "how_to_apply": "string"
            }
          ]
        },
        "narrative_to_visual": {
          "visual_storytelling": "string",
          "visual_narrative_elements": [
            {
              "narrative_aspect": "string",
              "visual_expression": "string"
            }
          ]
        },
        "art_direction_summary": "string",
        "design_elements": [
          {
            "description": "string",
            "significance": "string",
            "screenshot_index": 0,
            "region": {
              "x": 0,
              "y": 0,
              "width": 0,
              "height": 0
            }
          }
        ],
        "llm_image_prompt": {
          "prompt": "string",
          "optimised_for": "string"
        }
      },
      "northstart-statement": {
        "situation_context": "juggling business and personal responsibilities",
        "target_audience": "busy entrepreneurs",
        "pain_point": "string",
        "motivation_goal": "put their marketing on autopilot",
        "desired_outcome": "string",
        "belief_aspiration": "string",
        "product_name": "string",
        "product_category": "string",
        "core_benefit": "string",
        "how_it_works": "string",
        "competitor_alternative": "string",
        "competitor_limitation": "string",
        "differentiator": "string",
        "transformation": "a complete brand guide in under five minutes"
      },
      "web": {
        "component_libraries": [
          {
            "name": "shadcn/ui",
            "url": "http://example.com",
            "version": "2.x",
            "notes": "string"
          }
        ],
        "css_framework": {
          "name": "Tailwind CSS",
          "version": "4.x",
          "theme_config_url": "http://example.com",
          "notes": "string"
        },
        "icon_libraries": [
          {
            "name": "shadcn/ui",
            "url": "http://example.com",
            "version": "2.x",
            "notes": "string"
          }
        ],
        "meta_frameworks": [
          {
            "name": "shadcn/ui",
            "url": "http://example.com",
            "version": "2.x",
            "notes": "string"
          }
        ],
        "state_management": [
          {
            "name": "shadcn/ui",
            "url": "http://example.com",
            "version": "2.x",
            "notes": "string"
          }
        ],
        "auth": [
          {
            "name": "shadcn/ui",
            "url": "http://example.com",
            "version": "2.x",
            "notes": "string"
          }
        ],
        "language": "TypeScript (strict)",
        "runtime": "Node 22",
        "package_manager": "pnpm",
        "accessibility": "WCAG 2.2 AA",
        "animation": {
          "library": "Framer Motion",
          "reduced_motion": true,
          "notes": "string"
        },
        "deployment": [
          {
            "name": "shadcn/ui",
            "url": "http://example.com",
            "version": "2.x",
            "notes": "string"
          }
        ],
        "design_tokens": {},
        "preferred_patterns": [
          "string"
        ],
        "custom_urls": [
          {
            "label": "Storybook",
            "url": "http://example.com"
          }
        ],
        "notes": "string"
      }
    }
  }
}