AI Assist
Describe your business and who you sell to; AI proposes the scoring rules.
Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| POST | /v3/lead-scoring/ai-generate | AI-generate a scoring model |
POST
/v3/lead-scoring/ai-generateTry:
Request body
Website IdWebsite id (24 hex characters) from list_websites.
DescriptionPlain-English description of the ideal customer, e.g. "US software companies with 50-500 staff selling to finance teams". Steers the generated rules.
curl -X POST "https://rest-dash.revealid.xyz/v3/lead-scoring/ai-generate?privateKey=YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9", "description": "We sell HR software to UK and US companies with 50 to 1,000 employees; HR directors and COOs buy it."}'Response
Press Send request to try it with sample data.
What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| websiteId* | string | — | any |
| description* | string | — | any |
Use case: A first model for a new website
POST /v3/lead-scoring/ai-generate reads the website's pages, builds a model named "ICP Score - AI Generated" and saves it; description steers it, and what you write there takes priority over what the site suggests. It works once per website: a second call is refused with "AI Lead scoring model has already been generated!". For more models (one per product line, for example) create them with POST /admin/lead-scoring and set their rules with PUT /v3/lead-scoring/{modelId} (Scoring models API).