Documentation
Integrating with Neuron programmatically.
The Bot API lets external applications interact with your bots. You can send messages, get AI responses, and list conversations — all via REST API. This is useful for building custom frontends, integrating with other platforms, or automating workflows.
Each bot can have its own API keys. Go to the bot's API Keys tab to create one. Keys are prefixed with "nrn_" and can optionally have an expiry date. Use the key in the Authorization header.
Authentication
curl -X POST https://neuron-api.letschop.io/api/v1/bot-api/chat \
-H "Authorization: Bearer nrn_your_api_key" \
-H "Content-Type: application/json" \
-d '{"message": "Hello, what are your business hours?"}'POST /api/v1/bot-api/chat — Send a message and get an AI response synchronously. The bot uses its full configuration (system prompt, knowledge bases, tools) to generate the reply. Optionally provide a conversationId to continue an existing conversation.
Chat request
{
"message": "What products do you offer?",
"conversationId": "optional-existing-conversation-id",
"contactPhone": "+1234567890",
"contactName": "John"
}POST /api/v1/bot-api/send — Queue a WhatsApp message to be sent via the bot's connected channel. Unlike /chat, this does not trigger an AI response — it simply sends the message you provide.
GET /api/v1/bot-api/conversations — List all conversations for the bot. Supports pagination and status filtering. GET /api/v1/bot-api/conversations/:id/messages — Get messages in a specific conversation.
The Bot API is rate-limited to 60 requests per minute per API key. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, Retry-After) are included in every response.
For the full API reference with request/response schemas, visit the interactive API documentation at /api/docs.