DesignSystemBuilder
Operations of the Design System Builder API. Paths are relative to your deployment's API host.
GET /api/design-system-builder-api/design-system-builder
List design system builds
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
createdBy | query | string | no | Filter by creator user id. |
includeArchived | query | boolean | no | Include archived design system builds in results. Defaults to false so the main list endpoint hides terminated rows at the DB level. Ignored when status is provided explicitly — that filter wins. |
limit | query | number | no | |
page | query | number | no | |
status | query | DesignSystemBuildStatus | no | |
tag | query | string | no | Filter by tag (exact match). |
| Status | Description | Body |
|---|---|---|
| 200 | application/json DesignSystemBuilderResponseDtoPaginatedEnvelope |
POST /api/design-system-builder-api/design-system-builder
Create a design system build + provision its interactive agent
Authentication: none
Request body: application/json CreateDesignSystemBuilderDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json DesignSystemBuilderResponseDtoDataEnvelope |
GET /api/design-system-builder-api/design-system-builder/{id}
Get a design system build by id
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json DesignSystemBuilderResponseDtoDataEnvelope |
PATCH /api/design-system-builder-api/design-system-builder/{id}
Update design system build metadata (title, description).
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: application/json UpdateDesignSystemBuilderDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json DesignSystemBuilderResponseDtoDataEnvelope |
DELETE /api/design-system-builder-api/design-system-builder/{id}
Archive a design system build (terminates its interactive session). Idempotent.
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json DesignSystemBuilderResponseDtoDataEnvelope |
POST /api/design-system-builder-api/design-system-builder/{id}/kb-push
Push selected files or directories from the design system build session to a knowledge-base space. Optionally creates the target space if createSpace=true. Directory entries are expanded recursively.
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: application/json DesignSystemBuilderKBPushDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json DesignSystemBuilderKBPushResponseDtoDataEnvelope |
POST /api/design-system-builder-api/design-system-builder/{id}/launch
Hand off selected session deliverables + deliverables/PIPELINE_INTENT.md to work-orchestrator-api as a clarification-driven bootstrap. Returns the bootstrap jobId the frontend uses to navigate into the clarification chat. Keeps the design system build ACTIVE so the user can iterate further.
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: application/json LaunchPipelineDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json LaunchPipelineResponseDtoDataEnvelope |
POST /api/design-system-builder-api/design-system-builder/{id}/publish
Publish this build's authored design system into the Template Registry as the organisation's. Reads deliverables/xema-design-system.json and nothing else, records the evaluation the chosen kind declares, freezes a revision and proposes publication. Returns 202: promotion blocks on a human answering a Decision, so a pending-decision status is this call SUCCEEDING, not failing.
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: application/json PublishDesignSystemDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json PublishDesignSystemResponseDtoDataEnvelope |
POST /api/design-system-builder-api/design-system-builder/{id}/restart
Replace the interactive session backing this design system build. Used when the prior session has ended unrecoverably. The old session id is kept in previousSessionIds as an audit trail.
Authentication: none
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json DesignSystemBuilderResponseDtoDataEnvelope |