Base URL
Identifying a project
Every list endpoint requires you to identify which project to read from. You can pass either:| Query parameter | Example | When to use |
|---|---|---|
projectSlug | ?projectSlug=my-project | Most cases — the slug is stable and human-readable |
projectId | ?projectId=4f8c... | When you already have the internal UUID |
GET /api/prompts/{id}) take the resource ID directly in the path and do not need a project parameter.
Response shape
All endpoints return JSON. List endpoints wrap their results in a top-level key matching the resource name:Errors
| Status | Body | Cause |
|---|---|---|
400 | {"error": "projectSlug or projectId is required"} | Missing required query param |
401 | {"error": "Not authenticated"} | Missing or invalid credentials |
403 | {"error": "Forbidden"} | Resource does not belong to your organization |
404 | {"error": "Not found"} | Resource does not exist |
Endpoints
Prompts
Active prompt versions and version history
Knowledge Docs
Knowledge base documents and version history
Traces
Traces, spans, approved outputs, and feedback