NUWAY API
Requests and responses
These conventions apply to every NUWAY API endpoint.
Conventions
| Topic | Rule |
|---|---|
| Base URL | https://ai.nuway.co/api/v1/external |
| Format | JSON request and response bodies, UTF-8. File uploads use multipart/form-data. |
| Timestamps | ISO 8601, e.g. 2026-10-11T08:27:52.793544+00:00. Dates are YYYY-MM-DD. |
| Time zones | IANA names, e.g. America/New_York, Europe/London, Asia/Dubai. |
| Timeouts | Chat replies usually take 2–8 seconds; a turn that books a meeting can take longer. Use a client timeout of at least 60 seconds for chat. |
| Fields | Responses may gain new fields over time. Ignore fields you don't use rather than failing on them. |
Pagination
List endpoints use one of two styles, noted on each endpoint:
- Offset style (
limit,offset). The response includestotalandhas_more. - Page style (
pagestarting at 0,size). The response includestotalElements,totalPagesandnumber(the current page).
| Endpoint | Style |
|---|---|
| List conversations | Offset |
| List leads | Offset |
| List knowledge | Page |
Filtering and sorting
Filters and sort options are query parameters, listed with each endpoint in the API reference. For example, List leads filters by rank and sorts with sort.
Errors
Unsuccessful requests return an HTTP status and a JSON body with detail. See Errors and rate limits.