Design System Builder API: schemas

The request and response bodies of the operations in this API.

CreateDesignSystemBuilderDto

Property	Type	Required	Description
`description`	string	no
`sessionLaunch`	object	yes
`tags`	array of string	no	Initial tags for list-page filtering.
`title`	string	yes

DesignSystemBuildStatus

Type: one of "creating", "active", "archived"

DesignSystemBuilderKBPushDto

Property	Type	Required	Description
`createSpace`	boolean	no	Create the space if it does not exist.
`entries`	array of KBPushEntryDto	yes	Files and directories from the design system build session workspace to push.
`spaceSlug`	string	yes	Target space slug. The space must exist or createSpace must be true.
`spaceTitle`	string	no	Human-readable title to use when creating the space. Required when createSpace=true and the space does not yet exist.
`targetParentSlug`	string	no	Slug of an existing KB page to use as the parent for pushed pages. When omitted, pages are created at the root of the space.

DesignSystemBuilderKBPushResponseDto

Property	Type	Required	Description
`pageIds`	array of string	yes	IDs of the created KB pages.
`pagesCreated`	number	yes	Total number of KB pages created.
`spaceSlug`	string	yes	Space slug where pages were created.

DesignSystemBuilderKBPushResponseDtoDataEnvelope

Property	Type	Required	Description
`data`	DesignSystemBuilderKBPushResponseDto	yes

DesignSystemBuilderResponseDto

Property	Type	Required	Description
`createdAt`	string (date-time)	yes
`createdBy`	string	yes
`description`	object or null	no
`failureReason`	object or null	no	Human-readable error when create or archive failed. Null on healthy rows.
`id`	string	yes
`latestBootstrapJobId`	object or null	no	Most recent bootstrap job id launched from this design system build. The frontend uses this to navigate into the clarification chat; the pipeline run itself is created later, after the clarification contract is approved.
`orgId`	string	yes
`previousSessionIds`	array of string	yes	Audit of sessions superseded by /restart.
`projectId`	string	yes
`sessionId`	object or null	no	Active agent-session id. Null during CREATING, or after a restart while the fresh session is provisioning.
`sessionStatus`	object or null	no	Cached live lifecycle status of the underlying agent-session (e.g. active, paused, recovering). Distinct from `status` (the project-lifecycle); reflects worker-liveness so the list stays honest while a session is paused. Null until the first session lifecycle event is observed.
`status`	DesignSystemBuildStatus	yes
`tags`	array of string	yes
`title`	string	yes
`updatedAt`	string (date-time)	yes

DesignSystemBuilderResponseDtoDataEnvelope

Property	Type	Required	Description
`data`	DesignSystemBuilderResponseDto	yes

DesignSystemBuilderResponseDtoPaginatedEnvelope

Property	Type	Required	Description
`data`	array of DesignSystemBuilderResponseDto	yes
`pagination`	PaginationMeta	yes

KBPushEntryDto

Property	Type	Required	Description
`path`	string	yes	Workspace-relative file or directory path.
`type`	one of `"file"`, `"directory"`	yes	Whether the path is a file or a directory.

LaunchPipelineDto

Property	Type	Required	Description
`intentMarkdown`	string	yes	Final pipeline brief — the user-edited contents of `deliverables/PIPELINE_INTENT.md` at launch time. Frozen server-side; later session edits do not retroactively modify this handoff.
`outputPaths`	array of string	yes	User-selected deliverable paths (scoped to `deliverables/**` in the session workspace). At least one path is required — the launch modal should disable the submit button otherwise.

LaunchPipelineResponseDto

Property	Type	Required	Description
`jobId`	string	yes	Workflow-engine run ID created by the launch. The frontend uses this to navigate directly to the pipeline run detail page.
`threadId`	string	yes	Workflow-engine run ID echoed as threadId for reconciliation. Clients should key off `jobId`.
`workflowSlug`	string	yes	Workflow slug used for this run. The frontend uses this to build the pipeline run URL without hardcoding the slug.

LaunchPipelineResponseDtoDataEnvelope

Property	Type	Required	Description
`data`	LaunchPipelineResponseDto	yes

PaginationMeta

Property	Type	Required	Description
`hasMore`	boolean	no
`limit`	number	no
`nextCursor`	string or null	no
`page`	number	no
`previousCursor`	string or null	no
`total`	number	no
`totalPages`	number	no

PublishDesignSystemDto

Property	Type	Required	Description
`designSystemKind`	string	yes	`<namespace>/<kind>[.<segment>]@<major>` — one the org has installed.
`releaseChannel`	string	no	Defaults to `stable`, which is what the org-brand selector binds. Optional rather than fixed because the channel is an open vocabulary in the kernel; stated here so a caller CAN publish elsewhere without this surface pretending the choice does not exist.

PublishDesignSystemResponseDto

Property	Type	Required	Description
`intentId`	string	yes
`resourceId`	string	yes
`revisionId`	string	yes
`status`	string	yes	pending \| dispatching \| pending-decision \| promoted \| denied \| failed. Anything other than denied/failed means the publication is in flight.

PublishDesignSystemResponseDtoDataEnvelope

Property	Type	Required	Description
`data`	PublishDesignSystemResponseDto	yes

UpdateDesignSystemBuilderDto

Property	Type	Required	Description
`description`	object or null	no	Updated description for the design system build session
`title`	string	no	New title for the design system build session