Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Headless notebook engine for grounded research, RAG, and citations in Allternit.
Documentation
Plugins & MCP Apps
API Reference
SDKhttp://127.0.0.1:5055
| Method | Path | Description |
|---|---|---|
| GET | /health | Service health |
| GET | /api/notebooks | List notebooks |
| POST | /api/notebooks | Create a notebook |
| GET | /api/notebooks/{id} | Get a notebook |
| PATCH | /api/notebooks/{id} | Update a notebook |
| DELETE | /api/notebooks/{id} | Delete a notebook and its data |
| POST | /api/notebooks/{id}/share | Share a notebook |
| POST | /api/notebooks/{id}/unshare | Unshare a notebook |
| GET | /api/notebooks/{id}/sources | List sources |
| POST | /api/notebooks/{id}/sources | Add a source |
| DELETE | /api/notebooks/{id}/sources/{source_id} | Remove a source |
| GET | /api/notebooks/{id}/chat/messages | List chat messages |
| POST | /api/notebooks/{id}/chat | Stream a grounded chat response |
| POST | /api/notebooks/{id}/search | Search within a notebook |
| POST | /api/notebooks/{id}/transform | Transform notebook content |
| POST | /api/notebooks/{id}/podcast | Generate podcast audio |
| GET | /api/notebooks/{id}/connectors/available | List available connectors |
| POST | /api/notebooks/{id}/connectors/{connector_type}/sync | Sync a connector into the notebook |
| POST | /api/notebooks/{id}/canvas-sync | Canvas LMS sync |
| GET | /api/reddit/r/{subreddit} | Reddit subreddit research helper |
| GET | /api/reddit/user/{username} | Reddit user research helper |
/data.
curl -X POST http://127.0.0.1:5055/api/notebooks \
-H 'content-type: application/json' \
-d '{
"title": "Q3 Research",
"description": "Quarterly research notes",
"owner_id": "user_123"
}'
{
"id": "nb_1",
"title": "Q3 Research",
"description": "Quarterly research notes",
"owner_id": "user_123",
"shared_with": [],
"source_count": 0,
"token_count": 0,
"created_at": "2026-08-13T19:00:00.000Z",
"updated_at": "2026-08-13T19:00:00.000Z"
}
curl -X POST http://127.0.0.1:5055/api/notebooks/nb_1/sources \
-H 'content-type: application/json' \
-d '{
"type": "text",
"title": "Annual Report",
"content": "Revenue increased by 20% year over year..."
}'
{
"id": "src_1",
"notebook_id": "nb_1",
"type": "text",
"title": "Annual Report",
"content": "Revenue increased by 20% year over year...",
"token_count": 12,
"status": "extracted",
"created_at": "2026-08-13T19:00:00.000Z",
"updated_at": "2026-08-13T19:00:00.000Z"
}
curl -X POST http://127.0.0.1:5055/api/notebooks/nb_1/chat \
-H 'content-type: application/json' \
-d '{"message":"What was the revenue growth?"}'
data: {"text":"Revenue grew"}
data: {"text":" by 20%"}
data: {"citation":{"index":1,"source_id":"src_1","excerpt":"Revenue increased by 20% year over year"}}
data: {"done":true}
| Variable | Purpose |
|---|---|
PORT | HTTP port (default 5055) |
SURREAL_URL | SurrealDB connection URL (default ws://127.0.0.1:9800/rpc) |
SURREAL_NAMESPACE / SURREAL_DATABASE | SurrealDB namespace and database (default open_notebook) |
SURREAL_USER / SURREAL_PASSWORD | SurrealDB credentials (default root) |
ALLTERNIT_AI_URL | LLM proxy base URL (default http://127.0.0.1:8765) |
ALLTERNIT_API_KEY | Key sent to the LLM proxy |
OLLAMA_URL | Ollama fallback (default http://127.0.0.1:11434) |
TTS_PROVIDER | Podcast TTS: piper (default), ElevenLabs or OpenAI; uses ELEVENLABS_API_KEY, OPENAI_API_KEY, PIPER_MODEL_PATH |
| HTTP | Code | Meaning |
|---|---|---|
| 200 | — | Success |
| 400 | bad_request | Invalid payload |
| 404 | not_found | Notebook or source not found |
| 422 | unprocessable_entity | Validation failed |
| 500 | internal_error | Unexpected server error |