{"openapi":"3.1.0","info":{"title":"POST /api/v1/onboarding/ai-recommend","version":"1.0.0","description":"Generate personalised add-on recommendations"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/onboarding/ai-recommend":{"post":{"tags":["onboarding"],"summary":"Generate personalised add-on recommendations","description":"Analyses the full discovery conversation, extracts a structured business profile, and returns personalised add-on recommendations.","operationId":"ai_recommend","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIRecommendRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AIRecommendResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests - Rate limit exceeded; back off and retry","content":{"application/json":{"example":{"error":"rate_limited","message":"Too many requests. Please slow down.","code":"GEN_005","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"example":{"error":"server_error","message":"An internal error occurred. Please try again.","code":"GEN_003","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"ai_recommend_api_v1_onboarding_ai_recommend_post"}}},"components":{"schemas":{"AIRecommendRequest":{"properties":{"account_type":{"type":"string","pattern":"^(self-managed|dz-managed|advisory-firm)$","title":"Account Type"},"conversation":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array","maxItems":20,"minItems":1,"title":"Conversation","description":"Full discovery conversation"}},"type":"object","required":["account_type","conversation"],"title":"AIRecommendRequest","description":"Request body for the AI recommendation endpoint.\n\nSends the full discovery conversation so the AI can extract a structured\nprofile and generate personalised add-on recommendations."},"AIRecommendResponse":{"properties":{"recommendations":{"items":{"$ref":"#/components/schemas/AddonRecommendation"},"type":"array","title":"Recommendations","description":"Recommended add-ons sorted by priority"},"profile":{"additionalProperties":true,"type":"object","title":"Profile","description":"Structured profile data extracted from the conversation"},"summary":{"type":"string","title":"Summary","description":"One-paragraph personalised summary for the user","default":""}},"type":"object","title":"AIRecommendResponse","description":"Response from the AI recommendation endpoint."},"AddonRecommendation":{"properties":{"addon_id":{"type":"string","title":"Addon Id","description":"Add-on module ID (e.g. ai_pro, commerce)"},"name":{"type":"string","title":"Name","description":"Human-readable add-on name"},"reason":{"type":"string","title":"Reason","description":"Why this add-on is recommended for this user"},"priority":{"type":"string","enum":["must_have","recommended","optional"],"title":"Priority","description":"must_have, recommended, or optional","default":"recommended"}},"type":"object","required":["addon_id","name","reason"],"title":"AddonRecommendation","description":"A single add-on recommendation with reasoning."},"SuccessEnvelope_AIRecommendResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/AIRecommendResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AIRecommendResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}