Chatbots & routing

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

19 endpoints.

GET /manual-chatbot

Get all manual chatbots.

Auth apikey

:::note Used by the web app components/ManualChatbotTemplatesModal.jsx, pages/AddManualChatbot.jsx, pages/ManualChatbots.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of manualChatbot objects, alongside the pagination fields described in Response format. updatedBy, createdBy are populated, so they arrive as nested objects rather than ids.

POST /manual-chatbot

Create manual chatbot.

Auth apikey

:::note Used by the web app components/ManualChatbotTemplatesModal.jsx, pages/AddManualChatbot.jsx, pages/ManualChatbots.jsx :::

Request body

Field	Default
name	—
description	—
status	—
nodes	[]
edges	[]

Required: name.

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

DELETE /manual-chatbot

Delete manual chatbot.

Auth apikey

:::note Used by the web app components/ManualChatbotTemplatesModal.jsx, pages/AddManualChatbot.jsx, pages/ManualChatbots.jsx :::

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /manual-chatbot/:id

Get manual chatbot.

Auth apikey

:::note Used by the web app components/ChatWindow.jsx, components/ManualChatbotAiModal.jsx, pages/AddManualChatbot.jsx and 1 more :::

Path parameters

Name
id	Required

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

PUT /manual-chatbot/:id

Update manual chatbot.

Auth apikey

:::note Used by the web app components/ChatWindow.jsx, components/ManualChatbotAiModal.jsx, pages/AddManualChatbot.jsx and 1 more :::

Path parameters

Name
id	Required

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

DELETE /manual-chatbot/:id

Delete manual chatbot.

Auth apikey

:::note Used by the web app components/ChatWindow.jsx, components/ManualChatbotAiModal.jsx, pages/AddManualChatbot.jsx and 1 more :::

Path parameters

Name
id	Required

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /manual-chatbot/ai-generate

Generate manual chatbot with AI.

Auth apikey

Request body

Field	Default	Notes
prompt	—	The outreach goal, in plain language.

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors AIUsageLimitReached_429

GET /manual-chatbot/chatbot-router

Get chatbot router.

Auth apikey

PUT /manual-chatbot/chatbot-router

Update chatbot router.

Auth apikey

GET /manual-chatbot/chatbot-router/apps

Get entry point apps.

Auth apikey

:::note Used by the web app pages/ChatbotManager.jsx :::

GET /manual-chatbot/chatbot-router/bots

Get routable chatbots.

Auth apikey

:::note Used by the web app pages/AddManualChatbot.jsx, pages/ChatbotManager.jsx :::

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /manual-chatbot/chatbot-router/entry-points

Create entry point.

Auth apikey

:::note Used by the web app pages/ChatbotManager.jsx :::

Request body

Field	Default
channel	—

Required: channel.

PUT /manual-chatbot/chatbot-router/entry-points/:entryPointId

Update entry point.

Auth apikey

:::note Used by the web app pages/ChatbotManager.jsx :::

Path parameters

Name
entryPointId	Required

DELETE /manual-chatbot/chatbot-router/entry-points/:entryPointId

Delete entry point.

Auth apikey

:::note Used by the web app pages/ChatbotManager.jsx :::

Path parameters

Name
entryPointId	Required

POST /manual-chatbot/chatbot-router/entry-points/:entryPointId/test

Test chatbot router.

Auth apikey

:::note Used by the web app pages/ChatbotManager.jsx :::

Path parameters

Name
entryPointId	Required

Request body

Field	Default
text	—

Required: text.

Response — data is one manualChatbot object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /manual-chatbot/chatbot-router/rebuild

Rebuild chatbot router indexes.

Auth apikey

:::note Used by the web app pages/ChatbotManager.jsx :::

GET /manual-chatbot/chatbot-router/session/stop

Get chatbot session status.

Auth apikey

:::note Used by the web app components/ChatWindow.jsx :::

Response — data is one ResponseMessage object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

PUT /manual-chatbot/chatbot-router/session/stop

Stop chatbot session.

Auth apikey

:::note Used by the web app components/ChatWindow.jsx :::

Request body

Field	Default
channel	—
app	—
account	null

Required: channel, app.

Response — data is one ResponseMessage object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /manual-chatbot/keywords

Extract manual chatbot keywords.

Auth apikey