Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.langsight.dev/llms.txt

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

​
What is a project?

A project is the top-level isolation boundary in LangSight. Every span, session, SLO, alert rule, and cost record belongs to exactly one project. Users see only the projects they are members of. Use projects to separate environments (production vs staging), teams (platform vs product), or products.

​
Default project

On first run, LangSight creates a Default project automatically. All dashboard pages scope to this project. Create additional projects via the sidebar → New Project.

​
Creating projects

In the dashboard: click the project switcher in the sidebar → New Project → enter a name. Via API: 
POST /api/projects
Content-Type: application/json
X-API-Key: ls_your_key

{
  "name": "Production",
  "slug": "production"
}

​
Finding your project ID

The project ID is required to tag SDK spans to the right project. From the dashboard: Settings → Projects → click the abc12345… pill next to the project name. The full ID copies to clipboard. From the API: 
curl http://localhost:8000/api/projects \
  -H "X-API-Key: your-api-key"
Response: 
[
  { "id": "abc123def456...", "name": "Default", "slug": "default" },
  { "id": "xyz789...", "name": "Production", "slug": "production" }
]
Copy the id value for your project into your SDK config or .env: 
LANGSIGHT_PROJECT_ID=abc123def456...

​
Sending spans to a project

Set project_id on LangSightClient: 
import os
from langsight.sdk import LangSightClient

client = LangSightClient(
    url=os.getenv("LANGSIGHT_URL", "http://localhost:8000"),
    api_key=os.getenv("LANGSIGHT_API_KEY"),
    project_id=os.getenv("LANGSIGHT_PROJECT_ID"),
)
All spans from this client are tagged with the configured project_id. You can also set project_id per span in the SDK or via the API: 
{
  "server_name": "jira-mcp",
  "tool_name": "get_issue",
  "project_id": "production",
  ...
}

​
Project roles

RoleWhat they can do
ownerFull access — invite members, delete project
memberRead + write spans, SLOs, alerts
viewerRead-only
Global admins (see Users) see all projects regardless of membership.

​
Project switcher

Click the project name in the sidebar to switch the active project. All dashboard pages filter to the selected project.

​
API reference

MethodPathDescription
GET/api/projectsList your projects
POST/api/projectsCreate a project (admin only)
GET/api/projects/{project_id}Project details
PATCH/api/projects/{project_id}Rename / update settings
DELETE/api/projects/{project_id}Delete (admin only, irreversible)
Deleting a project permanently deletes all spans, sessions, SLOs, and cost records in that project. This cannot be undone.