Blueprints
Workflow templates — the definition of what a Factory workflow does. A blueprint is created, modified, and versioned via these endpoints; running a blueprint creates an Assembly. The visual blueprint editor in the S-Launch UI is built on top of these endpoints.
Scopes
| Scope | Reach |
|---|---|
blueprints:read | Listing, reading, fetching thumbnails. |
blueprints:write | Creating, updating, deleting, uploading thumbnails. |
Endpoints
List Blueprints
GET /api/factory/workflows/
Returns a page of blueprint records.
Required scope: blueprints:read · also accepts API key
Query parameters — standard pagination set; see Conventions › Pagination. Defaults: sort_by=created, sort_order=desc, hydrate=true.
Response 200 — BlueprintInDbCursorPage
Get Blueprint Filter Metadata
GET /api/factory/workflows/filters
Returns filter/operator/sort options for List Blueprints.
Required scope: blueprints:read
Response 200 — open metadata object.
Get Blueprint by ID
GET /api/factory/workflows/{id}
Returns a single blueprint.
Required scope: blueprints:read · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Blueprint ID. |
Response 200 — BlueprintRead
Get Blueprint Thumbnail
GET /api/factory/workflows/{id}/thumbnail
Returns the thumbnail image for the blueprint (used by gallery views in the UI).
Required scope: blueprints:read
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Blueprint ID. |
Response 200 — image bytes.
Create Blueprint
POST /api/factory/workflows/
Creates a new blueprint.
Required scope: blueprints:write
Request body — BlueprintWriteCreate
Response 201 — BlueprintRead
Update Blueprint by ID
PUT /api/factory/workflows/{id}
Replaces the blueprint definition.
Required scope: blueprints:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Blueprint ID. |
Request body — BlueprintWriteReplace
Response 200 — BlueprintRead
Patch Blueprint
PATCH /api/factory/workflows/{id}
Partial blueprint update.
Required scope: blueprints:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Blueprint ID. |
Request body — BlueprintWriteUpdate
Response 200 — BlueprintRead
Delete Blueprint by ID
DELETE /api/factory/workflows/{id}
Removes the blueprint definition. Existing Assemblies that ran this blueprint are retained as historical records.
Required scope: blueprints:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Blueprint ID. |
Response 204 — empty.
Upload Blueprint Thumbnail
POST /api/factory/workflows/{id}/thumbnail
Uploads a thumbnail image for the blueprint.
Required scope: blueprints:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Blueprint ID. |
Request body — Body_Blueprints-upload_thumbnail (multipart/form-data).
Response 200 — BlueprintRef
See also
- Tickets — requests to run a blueprint.
- Assemblies — execution histories produced by running a blueprint.
- Builder Helpers — smartnames, factory store, and the UCS scope catalogue used in the editor.