Endpoints

All endpoints are relative to https://api.kibee.ai. SDK endpoints require a publishable key; admin endpoints require a secret key or Auth0 JWT.

SDK endpoints

GET /flows/:id

Fetch a single flow definition by ID. Called automatically by the browser SDK.

{
  "id": "invite-team",
  "title": "Invite your team",
  "pageId": "settings",
  "goal": "Guide admin through inviting a teammate",
  "introMessage": "Let's invite a teammate.",
  "phrases": ["invite team", "add a user"],
  "steps": [ ... ]
}

POST /sessions

Create a new SDK session for a visitor.

{
  "pageId": "settings",
  "visitorId": "vis_abc123"
}

POST /intent/resolve

Match a free-text query to the best available flow.

{
  "input": "how do I invite my team?",
  "pageId": "settings",
  "visibleTargets": [
    { "id": "invite-email", "label": "Invite email field" }
  ]
}

{
  "flowId": "invite-team",
  "confidence": 0.91,
  "message": "I'll guide the invite team flow."
}

POST /events

Track a user event — page view, step completion, flow outcome, and so on.

{
  "type": "step_complete",
  "pageId": "settings",
  "flowId": "invite-team",
  "targetId": "invite-email",
  "sessionId": "ses_xyz789",
  "timestamp": "2026-04-26T07:29:00Z"
}

Admin endpoints

GET /admin/flows

List all flows for the authenticated workspace.

POST /admin/flows

Create a new flow. Body matches the flow structure.

PUT /admin/flows/:id

Update an existing flow.

DELETE /admin/flows/:id

Delete a flow.

GET /admin/sessions

List recent sessions with event counts and status.

GET /admin/sessions/:id

Get details for a single session, including step history and messages.

POST /admin/sessions/:id/push-flow

Push a flow to a live session from the Hive — the bee starts guiding the user in real time without any action required on their side.

GET /admin/analytics

Aggregate session, flow completion, and friction metrics for the workspace.

GET /admin/friction

Friction scores per page — stall counts, abandon rates, and completion rates.

GET /admin/keys · POST /admin/keys · DELETE /admin/keys/:id

Manage API keys for the workspace.