Introduction

The Humaner API gives you access to Humaner backend, agents, memory and handoff framework. Share a base URL, authentication scheme and response format described jsut below.

Features

Base URL

https://app.humaner.io

Endpoints

MethodPathPurpose
POST/api/v1/chatSend a message, stream the reply (Humaner)
POST/api/v1/intelligence/retrieveSearch knowledge (Custom + Humaner, API key)
POST/api/v1/intelligence/create-ticketOpen a Human Desk ticket (Custom + Humaner)
POST/api/v1/intelligenceInvoke any Intelligence tool by name
GET/api/v1/agents/{publicId}Fetch agent name, character, greeting
POST/api/v1/visitors/identifyAttach a visitor ID for cross-session memory
POST/api/v1/handoff/ticketCreate a the desk ticket for handoff
POST/api/v1/widget/proactiveQueue a popup teaser for an identified visitor

Authentication

Every endpoint takes the same Bearer API key you created.

Authorization header

Authorization: Bearer hm_live_xxxxxxxx

Response conventions

EndpointResponse type
POST /api/v1/chattext/event-stream (SSE). See the Chat reference
All othersapplication/json

Errors are always { "error": "message" }. Full table detailed on Errors page.

Plan gating

API access needs Custom or Humaner.