Documentation menu
API reference
Platform
https://api.cogitan.ai/v1/fluxus; a local engine serves the same route under /api. GET routes are free on the hosted API; every POST consumes one call of quota./v1/fluxus/capabilities
engine path /api/capabilities · free
MACHINE-READABLE CAPABILITY MANIFEST. Start here if you are an agent.
What it does, in full
MACHINE-READABLE CAPABILITY MANIFEST. Start here if you are an agent.
/openapi.json already says what can be CALLED. This says what may be BELIEVED, which is the question an autonomous caller actually has to answer before using a number. Every entry carries, alongside its JSON Schema:
fidelity -- what the ground truth behind it IS (analytic
closed form / surrogate of an analytic oracle / surrogate of an
EM solve / exact diagonalisation). Nothing here is silicon.
* validation -- the measured held-out error, with the reference
it was measured against and the split used.
* envelope -- the input box the answer is trusted inside.
* refuses_when -- the conditions under which it returns a
refusal instead of a number, so a caller can predict a 422
instead of discovering it.Schemas are generated from the request models, so they cannot drift from what the endpoints accept.
Request
No parameters.
Example
curl -s "$FLUXUS_API/capabilities" -H "Authorization: Bearer $COGITAN_API_KEY"CLI: fluxus capabilities
Example body: no parameters
What it refuses
No refusal list is served for this route. Invalid input is a 400 or 422 with the error envelope; any refusal it makes is described above.
Responses: 200 Successful Response.
Validated for
This route has no card in the capability manifest; read its description above for what it rests on.
/v1/fluxus/cells
engine path /api/cells · free
Cell library for the floorplan desk: SFQ + quantum cell types.
What it does, in full
Cell library for the floorplan desk: SFQ + quantum cell types.
CELL_REGISTRY (the single source
of truth) via the analytic per-cell schema, so ALL EIGHT validated RSFQ
cells appear -- jtl, splitter, merger, dff, and2, or2, dro, clock_splitter
-- each with its knob schema, logical ports, and a clocked flag so the
UI knows which cells need a clock. The legacy Margo-surrogate custom
netlist cell and the quantum transmon cell are preserved. sfq_available
/ sfq_error carry the surrogate-suite availability through unchanged.Request
Query parameters
Example
curl -s "$FLUXUS_API/cells" -H "Authorization: Bearer $COGITAN_API_KEY"No CLI command answers this route.
Example body: no parameters
What it refuses
No refusal list is served for this route. Invalid input is a 400 or 422 with the error envelope; any refusal it makes is described above.
Responses: 200 Successful Response; 422 Validation Error.
Validated for
This route has no card in the capability manifest; read its description above for what it rests on.
/v1/fluxus/engines
engine path /api/engines · free
Typed engine registry: metadata for every QEM prediction engine.
What it does, in full
Typed engine registry: metadata for every QEM prediction engine.
Returns {"engines": [record, ...], "default": <name>} where each record is one EngineAdapter.metadata(): name, version, source (honest provenance label), fidelity (analytic oracle vs. surrogate of it -- never EM-solver fidelity), available, description, and envelope (the SPEC_RANGES validity box, as {param: [lo, hi]}). default names the engine the auto QEM path currently dispatches to. The /api/qem engine override accepts any listed name; "surrogate" falls back to the oracle when no surrogate is loaded, with value.source staying honest.
Request
No parameters.
Example
curl -s "$FLUXUS_API/engines" -H "Authorization: Bearer $COGITAN_API_KEY"No CLI command answers this route.
Example body: no parameters
What it refuses
No refusal list is served for this route. Invalid input is a 400 or 422 with the error envelope; any refusal it makes is described above.
Responses: 200 Successful Response.
Validated for
This route has no card in the capability manifest; read its description above for what it rests on.
/v1/fluxus/registry
engine path /api/registry · free
Process registry: literature-derived generic records.
What it does, in full
Process registry: literature-derived generic records.
NOT validated PDK data -- each record carries source (citation) and confidence fields; treat values as order-of-magnitude anchors.
Request
No parameters.
Example
curl -s "$FLUXUS_API/registry" -H "Authorization: Bearer $COGITAN_API_KEY"CLI: fluxus registry
Example body: no parameters
What it refuses
No refusal list is served for this route. Invalid input is a 400 or 422 with the error envelope; any refusal it makes is described above.
Responses: 200 Successful Response.
Validated for
This route has no card in the capability manifest; read its description above for what it rests on.
Generated from Fluxus 0.3.0 at commit b9aa57d on 2026-10-20 by python -m fluxus.docs_bundle.