Projects, workflows and artifacts

The central API owns the engineering contract and the durable identities used across Studio, REST, Python and MCP.

Resource

Meaning

How to use it

Project

An accessible scope for related engineering work

Create/list using project endpoints; respect membership and credential restrictions

Workflow

Ownership and continuation context for project-optional work

Discover through get_workflow; continue from saved job links

Job

A geometry, mesh, simulation or prediction execution

Save its ID; follow status, events, request and outputs

Operation

Durable file import, inspection or viewer preparation

Save its operation ID; poll separately from compute

Artifact

A verified input, output, summary or view with metadata

Check kind, units, checksum, state and lineage before reuse

Design document

Typed, editable modelling intent

Validate/evaluate through the API; use Studio review to save project revisions

Projects are optional for supported submissions

Geometry, mesh, simulation and prediction requests accept an omitted project_id. New work without an input creates a private workflow; work with input artifacts inherits their scope. Inputs from incompatible scopes are rejected. A project-restricted credential still requires an allowed project or allowed input artifact.

Jobs always retain a concrete scope internally. Omitting a project does not make work public. list_jobs without a project lists the authenticated user’s work across entry points; broader accessible or organisation views have their own permissions.

Artifacts are not interchangeable

Use a ready geometry surface or supported CAD artifact for meshing. Use the verified simulation mesh artifact for Fluxcore. A display derivative, surface image, mesh section or downloaded interchange export is not automatically an accepted simulation input.

Inspect GET /v1/artifacts/{artifact_id} for kind, state, sha256, size_bytes, metadata and lineage. Filenames alone do not establish identity. Preserve the original input and its checksums when importing or creating derivatives.

Continue in Studio

Saved jobs include links.web for authenticated Studio navigation. The workspace Jobs page includes engineering work initiated through external clients. Project-optional work can be continued through Create Design project, which explicitly reviews sharing. It preserves engineering identities and does not rerun compute.

Studio revisions, proposals and reviews describe the accepted design state. The API’s returned edited document is a proposal until saved through that revision workflow. All evaluation, geometry, mesh and solver work still goes through the central service.