AI onboarding
Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.
7 endpoints.
GET /ai-onboarding
List onboarding runs.
Auth apikey
:::note Used by the web app
pages/AIOnboardingSettings.jsx
:::
Response — data is one AIOnboarding object.
POST /ai-onboarding/:id/apply
Apply onboarding.
Auth apikey
:::note Used by the web app
components/aiOnboarding/AIOnboardingWizard.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Response — data is one AIOnboarding object.
POST /ai-onboarding/:id/resume
Resume onboarding.
Auth apikey
:::note Used by the web app
pages/AIOnboardingSettings.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Response — data is one AIOnboarding object.
POST /ai-onboarding/:id/suggest
Suggest onboarding.
Auth apikey
:::note Used by the web app
components/aiOnboarding/AIOnboardingWizard.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Response — data is one AIOnboarding object. (Resource deduced from the collections this handler reads, not read off an explicit return.)
GET /ai-onboarding/latest
Get latest onboarding.
Auth apikey
:::note Used by the web app
components/aiOnboarding/AIOnboardingWizard.jsx, pages/AIOnboarding.jsx
:::
Response — data is one AIOnboarding object.
PUT /ai-onboarding/latest
Update latest onboarding.
Auth apikey
:::note Used by the web app
components/aiOnboarding/AIOnboardingWizard.jsx, pages/AIOnboarding.jsx
:::
Request body
| Field | Default |
|---|---|
about | — |
socials | — |
products | — |
Response — data is one AIOnboarding object.
POST /ai-onboarding/start
Start onboarding.
Auth apikey
:::note Used by the web app
components/aiOnboarding/AIOnboardingWizard.jsx
:::
Response — data is one AIOnboarding object.