Skip to main content

​
Usage

langsight serve [OPTIONS]

​
Options

OptionDefaultDescription
--host0.0.0.0Host to bind to
--port, -p8000Port to listen on
--configauto-discoveredPath to .langsight.yaml
--reloadfalseEnable auto-reload (development only)

​
What it does

Starts the FastAPI REST API server. The API is used by:
  • The LangSight SDK (POST /api/traces/spans)
  • OTLP integrations (POST /api/traces/otlp)
  • The Phase 4 dashboard
  • Any custom tooling querying health/security data

​
Start the server

langsight serve

Starting LangSight API on http://0.0.0.0:8000
Docs: http://localhost:8000/docs

​
API documentation

Once running, interactive docs are available at:
  • Swagger UI: http://localhost:8000/docs
  • ReDoc: http://localhost:8000/redoc

​
Endpoints

MethodPathDescription
GET/api/statusAPI health check
GET/api/health/serversLatest health for all servers
GET/api/health/servers/{name}Latest health for one server
GET/api/health/servers/{name}/historyHealth history
POST/api/health/checkTrigger on-demand health check
POST/api/security/scanTrigger security scan
POST/api/traces/spansIngest SDK spans
POST/api/traces/otlpIngest OTLP/JSON traces

​
Production deployment

For production, use the root docker-compose.yml: 
docker compose up -d
See Self-Hosting for the full production setup.