Skip to content

Tasks โ€‹

Individual steps inside an Assembly. A task represents a single unit of work โ€” a transform, a render, a publication step, a notification โ€” with its own status and output.

Tasks are read-mostly; the runtime creates and updates them automatically. The only write operation is deletion. They share the assemblies:* scopes with Assemblies because they live in the same execution-history domain.

Scopes โ€‹

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

Endpoints โ€‹

List Tasks โ€‹

GET /api/factory/tasks/

Returns a page of task records.

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

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

Response 200 โ€” TaskInDbCursorPage

Get Task Filter Metadata โ€‹

GET /api/factory/tasks/filters

Returns filter/operator/sort options for List Tasks.

Required scope: assemblies:read

Response 200 โ€” open metadata object.

Get Task by ID โ€‹

GET /api/factory/tasks/{id}

Returns a single task with its full status payload.

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

Path parameters

NameTypeRequiredDescription
idstringyesTask ID.

Response 200 โ€” TaskRead

Delete Task by ID โ€‹

DELETE /api/factory/tasks/{id}

Removes a task record. The owning Assembly is unaffected, but its task list will no longer include the deleted entry.

Required scope: assemblies:write

Path parameters

NameTypeRequiredDescription
idstringyesTask ID.

Response 204 โ€” empty.

See also โ€‹

  • Assemblies โ€” the parent record of a task.
  • Blueprints โ€” the workflow definition tasks correspond to.

S-Launch