elmo
Sign up

Analyze a website

POST
/tools/analyze

Run brand analysis without persisting anything. Returns suggested additional domains, aliases, competitors, and prompts.

Requires an instance admin key; organization keys receive 403.

Authorization

BearerAuth
AuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

website*string

Brand's website — a hostname or a full URL. A URL with a path (e.g. https://www.nike.com/golf) is analyzed as given; the returned website is always its domain.

Length1 <= length
brandName?string

Optional brand name hint. If omitted, inferred from the domain.

maxCompetitors?integer

Maximum number of competitor suggestions. 0 disables competitor generation entirely.

Range0 <= value <= 100
Default20
maxPrompts?integer

Maximum number of suggested prompts. 0 disables prompt generation entirely.

Range0 <= value <= 100
Default30

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/tools/analyze" \  -H "Content-Type: application/json" \  -d '{    "website": "string"  }'
{  "brandName": "string",  "website": "string",  "additionalDomains": [    "string"  ],  "aliases": [    "string"  ],  "competitors": [    {      "name": "string",      "domains": [        "string"      ],      "aliases": [        "string"      ]    }  ],  "suggestedPrompts": [    {      "prompt": "string",      "tags": [        "string"      ]    }  ]}