Loading docs
Understand how workflow records preserve visual design, generated source, route context, run history, and evidence pointers.
A workflow record is the durable unit of quantum work. It owns the visual design, generated source, route context, run history, comments, and evidence references.
Use this reference when an integration needs to import, duplicate, clone, or review a workflow without confusing private workspace state with public evidence.
Section 01
Workflow endpoints are session-authenticated and operate on the caller's own records. They serve the signed-in product UI and scripts that reuse a browser session.
GET /api/workflows?search={q}&limit={n} List your workflowsPOST /api/workflows Create a workflow recordGET /api/workflows/{id} Fetch one workflow recordPUT /api/workflows/{id} Update the record (only provided fields change)PATCH /api/workflows/{id} Alias of PUT (same partial update)DELETE /api/workflows/{id} Delete a workflowPOST /api/workflows/{id}/duplicate Duplicate into a new owner-scoped record
Section 02
A workflow record includes name, owner, workspace, visual operations, layout, qubit and classical-bit counts, revision, share and template flags, tags, and timestamps. Generated source is derived from the operations on demand.
Generated source can change when the visual circuit changes. Treat source snapshots used for a run as evidence artifacts rather than mutable draft text.
{"name": "Bell state baseline","qubits": 2,"classicalBits": 2,"operations": [{ "id": "op-1", "gate": "H", "targets": [0] },{ "id": "op-2", "gate": "CNOT", "targets": [1], "controls": [0] },{ "id": "op-3", "gate": "MEASURE", "targets": [0, 1], "classicalTargets": [0, 1] }],"tags": ["tutorial"]}
{"workflow": {"id": "cmbw1f2k80001abcd1234efgh","userId": "cmbvzx9aa0000abcd9012mnop","workspaceId": null,"name": "Bell state baseline","description": null,"qubits": 2,"classicalBits": 2,"revision": 1,"operations": [{ "id": "op-1", "gate": "H", "targets": [0] },{ "id": "op-2", "gate": "CNOT", "targets": [1], "controls": [0] },{ "id": "op-3", "gate": "MEASURE", "targets": [0, 1], "classicalTargets": [0, 1] }],"layout": {},"isPublic": false,"isTemplate": false,"isFavorite": false,"shareToken": null,"tags": ["tutorial"],"createdAt": "2026-06-12T09:28:00.000Z","updatedAt": "2026-06-12T09:28:00.000Z"}}
Section 03
Cloning public shares or templates creates a new owner-scoped record (POST /api/workflows/{id}/duplicate). It must not carry private provider credentials, billing state, admin notes, or original user secrets.
Imports validate circuit operations before a run can be routed; generated source is re-derived from those operations rather than imported as text.