Generate personalised add-on recommendations

POST /api/v1/onboarding/ai-recommend

Analyses the full discovery conversation, extracts a structured business profile, and returns personalised add-on recommendations.

Operation ID: ai_recommend_api_v1_onboarding_ai_recommend_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: AIRecommendRequest

account_type string required
conversation array · object required: Full discovery conversation

Responses

201 Successful Response

Schema: AIRecommendResponse

recommendations array · AddonRecommendation AddonRecommendation

Recommended add-ons sorted by priority

4 fields

addon_id string required

Add-on module ID (e.g. ai_pro, commerce)

name string required

Human-readable add-on name

reason string required

Why this add-on is recommended for this user

priority string

must_have, recommended, or optional

One of: must_have, recommended, optional

profile object

Structured profile data extracted from the conversation

summary string

One-paragraph personalised summary for the user

400 Bad Request - Invalid input

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

429 Too Many Requests - Rate limit exceeded

500 Internal Server Error

Code samples

POST /api/v1/onboarding/ai-recommend

bash

curl -X POST 'https://api.ondayzero.com/api/v1/onboarding/ai-recommend' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "account_type": "string",
  "conversation": []
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/onboarding/ai-recommend', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "account_type": "string",
  "conversation": []
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "account_type": "string",
  "conversation": []
}

response = httpx.post("https://api.ondayzero.com/api/v1/onboarding/ai-recommend", headers=headers, json=payload)
data = response.json()