API reference

Authentication

Requests are authorised with a Firebase identity token in the Authorization header. Tokens are short-lived — refresh them rather than storing them long term.

curl https://easyfastai.com/api/instances \
  -H "Authorization: Bearer <ID_TOKEN>"

Browser sessions may instead present the __session cookie, which the server validates on every protected route.

Health

Unauthenticated. Used by our status page.

• GET
  /api/health

  Returns service health. A non-200 response indicates degraded service.

Instances

An instance is one connected channel — a WhatsApp number or a web widget.

• GET
  /api/instances

  List every instance on your account.

• POST
  /api/instances

  Create an instance. Accepts instanceName, instanceDescription and channel.

• PUT
  /api/instances/:id

  Update an instance's name, description or assistant configuration.

• DELETE
  /api/instances/:id

  Delete an instance and its associated data.

• GET
  /api/instances/:id/analytics

  Message volume, response times and resolution metrics.

• GET
  /api/instances/:id/conversations

  Paginated conversation history for an instance.

• GET
  /api/instances/:id/leads

  Leads captured by the assistant.

WhatsApp

Connection lifecycle and outbound messaging.

• GET
  /api/whatsapp/:instanceId/status

  Current connection state for the instance.

• POST
  /api/whatsapp/:instanceId/connect

  Start a connection session and return pairing details.

• POST
  /api/whatsapp/:instanceId/send

  Send a message. Accepts a recipient number and message body.

• POST
  /api/whatsapp/:instanceId/broadcast

  Queue a broadcast to many recipients, with configurable delays.

• POST
  /api/whatsapp/:instanceId/disconnect

  End the session and release the connection.

Widgets

Embeddable web chat. The public endpoints are called by the widget itself.

• GET
  /api/widgets

  List web chat widgets on your account.

• PUT
  /api/widgets/:id

  Update appearance, behaviour and allowed domains.

• GET
  /api/widgets/public

  Public widget configuration, fetched by the embed script.

• POST
  /api/widgets/chat

  Send a visitor message and receive the assistant's reply.

• POST
  /api/widgets/chat/stream

  Same as above, streamed token by token over Server-Sent Events.

• POST
  /api/widgets/handoff/request

  Escalate a conversation to a human agent.

CRM

Contacts and aggregate reporting.

• GET
  /api/crm/contacts

  Search and filter contacts by instance and status.

• GET
  /api/crm/stats

  Totals across instances, contacts and messages.

• GET
  /api/crm/analytics

  Time-series analytics for a chosen period.

• GET
  /api/crm/export

  Export contacts for use in another system.