API reference

WAPI REST API

Base URL https://wapi.ncide.com. Every request is JSON over HTTPS. Interactive examples below are live — open a section and press Try it out.

Authentication

Send your key in the header of every call:

X-API-Key: wapi_live_...

Browser sessions use the wapi_sid cookie set by POST /api/auth/login; API keys are meant for servers and scripts.

Rate limits

Send endpoints are limited per key and per session. On breach you get 429 with {"error":"rate_limited"} and a Retry-After header.

Bulk jobs are queued server-side; poll the job or listen to the stream instead of polling fast.

Webhooks

Inbound messages are forwarded as POST JSON:

{
  "event": "message",
  "session_id": "s_123",
  "peer": "+15550001111",
  "direction": "inbound",
  "body": "Hi there",
  "created_at": "2026-09-28T10:15:00Z"
}

Return 200 quickly; retries are sent with backoff for 5xx and timeouts.

Interactive specification

Loaded from /openapi.json.

Loading the API specification…

Errors

400 invalid_request — malformed body or missing field

401 unauthorized — missing or invalid API key / session

404 not_found — unknown session, thread or key

409 conflict — session already connected or busy

429 rate_limited — slow down and retry

All errors share the shape {"error":"<code>"}.