Scrape Website For Signature

Public endpoint: extract brand identity from a website URL to prefill the Gmail Signature Generator form.

Reuses the authenticated brand-kit scraper under the hood; rate-limited to 5 calls/hour per IP via the RateLimitMiddleware entry for this path.

POST /api/v1/signature/scrape-website

Scrape Website For Signature

cURL

curl --request POST \
  --url https://api.example.com/api/v1/signature/scrape-website \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'

200

{
  "company": "<string>",
  "tagline": "<string>",
  "website": "<string>",
  "logo_url": "<string>",
  "accent_color": "<string>",
  "social_links": [
    {
      "platform": "<string>",
      "url": "<string>"
    }
  ],
  "suggested_template": "<string>",
  "template_reason": "<string>"
}

Body

application/json

url · string · required

Required string length: 4 - 2048

Response

200

application/json

Successful Response

company · string | null

tagline · string | null

website · string | null

logo_url · string | null

accent_color · string | null

social_links · SignatureSocialLink · object[]

Show child attributes

suggested_template · string | null

template_reason · string | null