company-profile

Analyze the company website

Read the given site, extract the company profile (LLM, structured), self-host the brand marks (primary logo + icon), and persist. The response carries how every step of the read finished.

post/v1/company-profile/analyze

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/company-profile/analyze
  • Auth: HTTP bearer

Headers

X-Tenant-Idstring nullable

Request body

website_urlstring required
mode'fill' | 'replace'

Response

Successful Response

website_urlstring nullable
brand_namestring nullable
target_audiencestring nullable
what_you_dostring nullable
differentiationstring nullable
tone_of_voicestring nullable
voice_warmthstring nullable
voice_formalitystring nullable
voice_lengthstring nullable
voice_technical_depthstring nullable
voice_emojiboolean nullable
sellsstring[]
brand_colorsstring[]
logo_urlstring nullable
analyzed_atstring date-time nullable
onboarding_completedboolean
color_rolesobject
chart_palettestring[]
chart_palettesobject
typographyobject
add_onsobject
themeobject nullable
brand_rulesobject
voice_traitsstring[]
brand_wordsobject
field_statesobject
brand_kit_versioninteger
hoststring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.