Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ntrp.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

http://localhost:6877
Configure with NTRP_HOST and NTRP_PORT.

​
Authentication

All endpoints except /health require a Bearer token: 
curl http://localhost:6877/session \
  -H "Authorization: Bearer YOUR_API_KEY"
See Authentication for details.

​
Response format

All endpoints return JSON. The event stream (GET /chat/events/{session_id}) uses Server-Sent Events (SSE).

​
Endpoints

GroupEndpointsDescription
ChatGET /chat/events, POST /chat/message, POST /chat/background, POST /cancelSSE stream, messaging, background mode
Sessions/session*, /sessions*Session management
Memory/facts*, /observations*, /dreams*Memory CRUD
Automations/automations*, /notifiers*Scheduled tasks, notifier configs
Config/config*, /models*, /providers*, /services*, /directivesConfiguration, providers, models
HealthGET /healthServer status (public)

​
Health check

curl http://localhost:6877/health

{
  "status": "ok",
  "version": "0.15.0"
}
Pass a Bearer token to also verify authentication: 
{
  "status": "ok",
  "version": "0.15.0",
  "auth": true
}