Configuration & API
Per-project configuration
Logic Context settings are stored as sparse overrides (config name brd). You change only what you need, and the rest tracks product defaults.
- Sections: enable, disable, rename, and reorder any of the 11 sections. At least one must stay enabled. The order you set is the order of the document.
- Quality gate: an enabled flag, a score threshold, a maximum retry count, and per-section overrides of all three.
- Artifact ID prefixes: override the default prefix for any of the 14 artifact families (letters, digits, and hyphens, up to 8 characters).
- Audience:
general,executive,technical, orauditor. - Prompt parameters: output language, a glossary of preferred terms, and a free-text addendum.
REST API
The base path is api/brd. The web application is a client of this API, so every capability is available programmatically.
Generation and streaming
| Method and path | Purpose |
|---|---|
POST /api/brd/generate | Start a BRD job and receive a jobId |
GET /api/brd/jobs/{jobId}/stream | Subscribe to the section progress stream (SSE) |
GET /api/brd/jobs/{jobId}/sections/{sectionId} | Get a completed section |
GET /api/brd/jobs/{jobId} | Get job status |
POST /api/brd/jobs/{jobId}/sections/{sectionId}/retry | Regenerate one section |
GET /api/brd/sections | Get the section catalog for a project |
Refinement and history
| Method and path | Purpose |
|---|---|
POST /api/brd/jobs/{jobId}/chat | Refine the document by natural-language request |
GET /api/brd/jobs/{jobId}/chat | Read the chat history for a job |
GET /api/brd/history/{projectName} | List past BRDs for a project |
GET /api/brd/history/content | Open a stored BRD by blob name |
Configuration
| Method and path | Purpose |
|---|---|
GET /api/brd/projects/{projectId}/config | Read the effective config plus overrides |
PUT /api/brd/projects/{projectId}/config | Save a sparse override document |
GET /api/projects | List available projects |
All endpoints require authentication and act on behalf of the signed-in user. See the Installation guide for the auth model.