NUWAY API
API reference
All endpoints use the base URL https://ai.nuway.co/api/v1/external (the legacy endpoint is the only exception) and the X-API-KEY header. Each page lists parameters, a cURL, JavaScript and Python example, the response and the errors.
| Endpoint | Method and path |
|---|---|
| Send a message | POST /api/v1/external/chat |
| List conversations | GET /api/v1/external/conversations |
| Get a conversation | GET /api/v1/external/conversations/{chat_id} |
| Get messages | GET /api/v1/external/conversations/{chat_id}/messages |
| List leads | GET /api/v1/external/leads |
| Get a lead | GET /api/v1/external/leads/{lead_id} |
| List team members | GET /api/v1/external/team-members |
| List meetings | GET /api/v1/external/meetings |
| Get free time slots | GET /api/v1/external/meetings/availability |
| Cancel a meeting | POST /api/v1/external/meetings/{meeting_id}/cancel |
| List knowledge | GET /api/v1/external/knowledge |
| Upload a document | POST /api/v1/external/knowledge/documents |
| Add an FAQ | POST /api/v1/external/knowledge/faqs |
| Update an FAQ | PUT /api/v1/external/knowledge/faqs/{id} |
| Delete knowledge | DELETE /api/v1/external/knowledge/{id} |
| Legacy chat | POST /api/v1/conversation |
In this section
ChatSend a customer's message to your AI workers and get the reply. The AI uses your trained knowledge, your products and your team's calendars, and it…ConversationsEvery conversation with your AI workers is here: API chats, website chats, voice calls, phone calls and SMS.LeadsA lead is one customer visit (a chat, a presentation or a call), scored by NUWAY for buying intent. These are the same leads you see in the dashboard.Team membersThe people customers can book meetings with. Use their email with the availability endpoint.MeetingsRead your team's meetings, find free times and cancel meetings. Meetings are booked through chat; to reschedule, cancel the meeting and book a new one…KnowledgeWhat your AI workers know comes from your training data: FAQs, documents, websites and more. Everything you add is trained automatically in the…Legacy endpointIntegrations built on NUWAY's earlier chatbot API keep working. New integrations should use POST /chat, which returns more information.