Skip to content

Main Navigation Download Guide Screenshots Plugins Themes Snippets

Plugin SDK

Core

Theme

Sidebar Navigation

Introduction

Guide

Prerequisites

Setup

Install and configure

Start the server

Production

Development only

Keep the server running

systemd (recommended on Linux)

PM2 (alternative)

What not to use in production

Typical workflow

Configuration

Sections overview

server

db

Postgres

MySQL

Firestore

redis

logging

llm

llm.mcp

plugins

docs

multitenancy

collaboration

Docker environment variables

Related docs

Deploy

Choose a guide

What is in the container

Bundled vs managed services

Image tags

Related docs

Authentication

Prerequisites

Roles and access

Roles

Access

Session introspection

Throttling

Manage users

Manage tokens

Onboarding invitations

Invite link format

Invitation secrets

LLM

Configuration

Hub MCP servers

User access

Agent loop

Hub-native documentation search

Monthly limits

Usage logging

Endpoints

CLI

Global options

Commands overview

start

migrate

collection list

llm list

tenant

tenant list

tenant create

tenant delete

user

user create

user list

user show

user update

user delete

user token

user token create

user token list

user token revoke

Examples

API Endpoints

Overview

Conventions

Timestamps

Errors

Empty responses

Shared types

Health

GET /health

GET /join

Authentication

GET /auth/session

PUT /auth/profile/avatar

GET /auth/users/:id/avatar

GET /auth/hub/avatar

Administration

GET /admin/users

PUT /admin/users/:id

DELETE /admin/users/:id

PUT /admin/hub/avatar

POST /admin/users

GET /admin/tokens

POST /admin/users/:id/tokens

DELETE /admin/tokens/:id

GET /admin/collections

PUT /admin/collections/:id

DELETE /admin/collections/:id

GET /admin/collections/:collectionId/documents

GET /admin/environments

PUT /admin/environments/:id

DELETE /admin/environments/:id

GET /admin/snippets

PUT /admin/snippets/:id

DELETE /admin/snippets/:id

GET /admin/llm/models

POST /admin/config/reload

Collections

GET /collections

POST /collections

PUT /collections/:id

DELETE /collections/:id

Environments

GET /environments

POST /environments

PUT /environments/:id

DELETE /environments/:id

Snippets

GET /snippets

POST /snippets

PUT /snippets/:id

DELETE /snippets/:id

Live Servers and Live Pages

GET /live-servers and GET /live-pages

POST /live-servers

POST /live-pages

PUT /live-servers/:id and PUT /live-pages/:id

DELETE /live-servers/:id and DELETE /live-pages/:id

GET /collections/:collectionId/folders

POST /collections/:collectionId/folders

PATCH /folders/:id

DELETE /folders/:id

PUT /collections/:collectionId/folders/reorder

Requests

GET /collections/:collectionId/requests

POST /collections/:collectionId/requests

PUT /requests/:id

DELETE /requests/:id

PUT /collections/:collectionId/requests/reorder

PUT /requests/:id/move

Documents

GET /collections/:collectionId/documents

POST /collections/:collectionId/documents

PUT /documents/:id

DELETE /documents/:id

PUT /collections/:collectionId/documents/reorder

PUT /documents/:id/move

Discussions

GET /requests/:id/discussions

POST /requests/:id/discussions

Other entity discussion routes

POST /discussion-comments/:id/replies

PUT /discussion-comments/:id

DELETE /discussion-comments/:id

Thread watches

MLS relay (E2EE hubs)

LLM routes

GET /llm/models

GET /llm/usage

POST /llm/chat/step

Plugin sources

GET /plugins/sources

Development

Build

Scripts

License

On this page

Build

bash

pnpm build
./dist/cli.js --help
pnpm start

Pager

Previous pageDevelopment

Next pageScripts

The HTTP workbench. Developer tools, built like tools.

Open source · MIT licensed

Build ​

Build