Skip to content

Assemblies โ€‹

The execution history of a Factory workflow. Every time a Blueprint runs (typically in response to a Ticket), one assembly record is produced. The assembly captures the run's start/finish times, the resolved input values, the per-step outcomes (Tasks), and any final artifacts.

Assemblies are read-mostly: they are produced by the runtime, not directly authored. The only write operation is deletion โ€” useful for trimming history that is no longer needed.

Scopes โ€‹

ScopeReach
assemblies:readListing, reading, viewing filters.
assemblies:writeDeleting assemblies.

Endpoints โ€‹

List Assemblies โ€‹

GET /api/factory/history/

Returns a page of assembly records.

Required scope: assemblies:read ยท also accepts API key

Query parameters โ€” standard pagination set; see Conventions โ€บ Pagination. Defaults: sort_by=started, sort_order=desc, hydrate=true.

Response 200 โ€” AssemblyInDbCursorPage

Get Assembly Filter Metadata โ€‹

GET /api/factory/history/filters

Returns filter/operator/sort options for List Assemblies.

Required scope: assemblies:read

Response 200 โ€” open metadata object.

Get Assembly by ID โ€‹

GET /api/factory/history/{id}

Returns a single assembly record, including its full step outcomes.

Required scope: assemblies:read ยท also accepts API key

Path parameters

NameTypeRequiredDescription
idstringyesAssembly ID.

Response 200 โ€” AssemblyRead

Delete Assembly by ID โ€‹

DELETE /api/factory/history/{id}

Removes the assembly from history. Useful for trimming completed runs whose detail is no longer needed; does not affect the underlying Blueprint.

Required scope: assemblies:write

Path parameters

NameTypeRequiredDescription
idstringyesAssembly ID.

Response 204 โ€” empty.

See also โ€‹

  • Blueprints โ€” the definition that produced this assembly.
  • Tickets โ€” the request that started this assembly.
  • Tasks โ€” the individual steps contained in this assembly.

S-Launch