Analyze

Performs a comprehensive structured analysis of a website’s UX and branding.

POST /api/agents/ux/analyze

Request Body


{
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "deliverables": {
    "branding_analysis": true,
    "ux_assessment": true,
    "recommendations": true
  },
  "options": {
    "language": "en",
    "includeScreenshot": true
  }
}

Parameter	Type	Required	Description
`site_id`	`string`	Yes	The UUID of the site to analyze.
`user_id`	`string`	No	The UUID of the user.
`deliverables`	`object`	No	Object specifying which analyses to perform.
`deliverables.branding_analysis`	`boolean`	No	Analyze branding elements (default: true).
`deliverables.ux_assessment`	`boolean`	No	Assess UX quality (default: true).
`deliverables.recommendations`	`boolean`	No	Generate improvement recommendations (default: true).
`deliverables.problems`	`boolean`	No	Identify UX problems (default: true).
`deliverables.opportunities`	`boolean`	No	Identify growth opportunities (default: true).
`options`	`object`	No	Configuration options for the analysis.
`options.language`	`string`	No	Language for the report (‘es’ or ‘en’).
`options.includeScreenshot`	`boolean`	No	Whether to capture a screenshot (default: true).

Response

Returns a detailed analysis object containing:

branding: Brand pyramid, archetype, voice & tone, visual identity.
ux_assessment: Scores for usability, accessibility, design, performance, and branding consistency.
recommendations: Prioritized list of actionable improvements.
problems: Identified issues categorized by severity.
opportunities: Strategic opportunities for growth.
analysis_id: UUID of the saved analysis record.

The endpoint also automatically updates the site’s branding settings if new information is discovered.