API

/ For teams with their own chat UI, mobile app, or custom surface. Humaner handles intelligence, retrieval, ticketing, and model routing. You render the pixels.

Before you start

  • An agent created in the dashboard. You need its ID.
  • An API key from Dashboard, then Settings, then API keys.

Beta

The API is in beta. Shapes are stable. Expect a few additions over time.

How it works

One primary call, POST /api/v1/chat, streamed as Server-Sent Events. Plus a lightweight GET for the agent's greeting, a POST to attach a known user for cross-session memory, and a POST to create Human Desk tickets from your own UI.

data: {"delta":"Your order shipped this morning..."}

data: {
  "metadata": {
    "intent": "order_status",
    "escalate": false,
    "cacheHit": true
  }
}

data: [DONE]

What stays widget-only

  • Live two-way chat with a human teammate. Widget and hosted Link only; the API gets async email handoff instead
  • Native in-chat UI components (product cards, booking calendars, return forms). You build these from the metadata signals

Full reference