> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pagepith.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Extract a brand profile

> Return company context, logos, colors, fonts, and social profiles for a public website.

A successful response consumes five credits. Internal retrieval details are not exposed in the public response.


## OpenAPI

````yaml POST /v1/api/brand
openapi: 3.1.0
info:
  title: PagePith API
  version: 0.1.0
  description: >-
    Turn any web page into clean, structured content. The API handles
    JavaScript-rendered sites, PDFs, and most bot-protected pages, returning
    readable markdown. Authenticate with your API key as a Bearer token. Usage
    is billed per successful scrape.
servers:
  - url: https://api.pagepith.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Scrape
    description: Fetch and convert web pages
  - name: Brand
    description: Extract company and visual-brand profiles
  - name: Video
    description: Transcribe public YouTube, Instagram, and TikTok videos
  - name: Monitoring
    description: Watch public pages for content changes
  - name: Blog
    description: Read published PagePith engineering articles
paths:
  /v1/api/brand:
    post:
      tags:
        - Brand
      summary: Extract a brand profile
      description: >-
        Inspect a public company website and return normalized company
        information, logos, colors, fonts, and social profiles. Every successful
        response costs five credits.
      operationId: extractBrand
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandRequest'
            example:
              url: https://stripe.com
      responses:
        '200':
          description: The normalized company and brand profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandProfile'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '422':
          description: The site did not expose enough usable brand evidence.
        '502':
          description: Company normalization failed.
        '504':
          description: Brand extraction exceeded its time limit.
components:
  schemas:
    BrandRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          format: uri
    BrandProfile:
      type: object
      required:
        - url
        - finalUrl
        - domain
        - name
        - description
        - industry
        - location
        - logos
        - colors
        - fonts
        - socials
        - sources
        - fetchedAt
      properties:
        url:
          type: string
          format: uri
        finalUrl:
          type: string
          format: uri
        domain:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        industry:
          type:
            - string
            - 'null'
        location:
          $ref: '#/components/schemas/BrandLocation'
        logos:
          type: array
          items:
            $ref: '#/components/schemas/BrandLogo'
        colors:
          type: array
          items:
            $ref: '#/components/schemas/BrandColor'
        fonts:
          type: array
          items:
            $ref: '#/components/schemas/BrandFont'
        socials:
          type: array
          items:
            $ref: '#/components/schemas/BrandSocial'
        sources:
          type: array
          items:
            type: string
            format: uri
        fetchedAt:
          type: string
          format: date-time
    BrandLocation:
      type:
        - object
        - 'null'
      properties:
        city:
          type: string
        region:
          type: string
        country:
          type: string
    BrandLogo:
      type: object
      required:
        - url
        - type
        - background
        - sourceUrl
        - confidence
      properties:
        url:
          type: string
          format: uri
        type:
          type: string
          enum:
            - logo
            - icon
        format:
          type: string
        width:
          type: integer
        height:
          type: integer
        background:
          type: string
          enum:
            - light
            - dark
            - any
        sourceUrl:
          type: string
          format: uri
        confidence:
          type: number
          minimum: 0
          maximum: 1
    BrandColor:
      type: object
      required:
        - hex
        - role
        - source
        - confidence
      properties:
        hex:
          type: string
          pattern: ^#[0-9A-F]{6}$
        role:
          type: string
          enum:
            - primary
            - secondary
            - accent
            - background
            - text
            - unknown
        source:
          type: string
          enum:
            - site
            - logo
        confidence:
          type: number
          minimum: 0
          maximum: 1
    BrandFont:
      type: object
      required:
        - family
        - weights
      properties:
        family:
          type: string
        weights:
          type: array
          items:
            type: integer
        role:
          type: string
          enum:
            - heading
            - body
            - unknown
    BrandSocial:
      type: object
      required:
        - platform
        - url
      properties:
        platform:
          type: string
        url:
          type: string
          format: uri
  responses:
    InvalidRequest:
      description: The request body failed validation.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - invalid_request
              details:
                type: object
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - unauthorized
              message:
                type: string
    PaymentRequired:
      description: No active subscription or usage allowance remaining.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                enum:
                  - payment_required
              message:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key as a Bearer token: `Authorization: Bearer <api-key>`.'

````