MaterialsCodeGraph

Archive or unarchive a simulation you own. Archiving hides it from the app's lists and studies; its runs, artifacts and spend are untouched, its direct link still opens, and archived false restores it. Use it to clear drafts that never ran (they cannot be deleted once quoted). Returns simulation_id, archived, archived_at (null when unarchived) and app_url.

Cancel a run from any non-terminal state before collecting (a collecting run's outputs are delivered and charged: 409). The cancel request is recorded immediately and returns run_id and cancel_requested true (and a note, for a running campaign); the platform kills the machine and terminalizes the run as state killed on its next orchestration tick (about 60 s). A running campaign's cancel takes several ticks (a tick is about 60 s), 3 or more while children are open: the parent winds down, its open children are cancelled (a collecting child finishes and counts), then settlement charges the done children's measured tokens and releases the rest of the hold. Poll mcg_get_run to observe the terminal state.

Enabled simulation kinds (each with example mcg_quote arguments that price, a note naming what must exist first, or both; traced says whether the kind's default lineage has a single public OpenMaterials node pin, traced_note why or why not; research coordinators instead expose record_contract describing per-task completion requirements, not completed results), the costed lineage menu (runnability, physical conditions, indicative token costs and wall time per resource class, with its label and the offer SKU priced), the external-frontier graphs mcg_quote accepts (each with the envelope to pass as external_frontier), recipes (pass a recipe's quote object to mcg_quote unchanged), and codes (versions, licenses, pins; the only software a run may execute). Call before mcg_quote. A kind or code absent here cannot run.

Connected clusters: id, name, preset (hive or auto), status (pending until the agent's first sync; connected; stale: the agent stopped syncing; revoked; scheduler_down: the agent syncs but cannot reach the scheduler, nothing is offered; agent_outdated: an auto cluster's agent sends no inventory; snapshot_rejected: its last snapshot was over the size cap; snapshot_stale: no fresh capacity snapshot, nothing is offered; nodes_unavailable: none of an auto cluster's nodes accept jobs (drained, down, in maintenance or not responding), nothing is offered), status_detail (why, when not connected), classes (resource classes offered per partition, with per-job GPU, CPU and memory maxima, the GRES type, and in_use: false when no engine runs on the class), unclassified_gpus (GPU types present but not offered: type, count, reason), untyped_gpus, last sync time. Pass target {cluster_id} to mcg_quote to run there at zero hardware cost; only a connected cluster quotes. Clusters are created with POST /api/clusters (on the machine host with a spend-scoped key).

Delete a study you own: the study and its membership list go. Its simulations, runs, artifacts and spend are untouched and stay reachable by id and in mcg_list_runs. Refused while the study has documents or a live public link (remove those in the app first). Returns study_id, deleted true and former_member_ids, enough to rebuild it.

List a run's collected artifacts as a typed manifest: artifacts, a list of path, bytes, stage and sha256 per file, plus removed on a file the retention sweep deleted (its bytes are gone; do not fetch it) and attribution on a third-party model's file (its license notice; keep it with any copy); truncated; source. Never returns file contents; fetch one file with mcg_get_artifact.

Fetch one artifact file's TEXT content, up to max_bytes (default 65536), with an explicit truncation note. Binary content REJECTS with unsupported_content; fetch binaries from the run's public page. A third-party model's file returns its full license notice first, as an [attribution] text item.

Fetch a run's state, event timeline and LLM spend. The payload leads with a derived summary (state, current_stage, billing {quoted_tokens, charged_tokens, hold, policy}, fault, refusal, next, last event, campaign) for cheap polling, then app_url (the run page, for the human), study and headline. events holds the newest events that fit about 12 KB plus the last complete or fail event; events_omitted counts the others. In a payload over 2 KB, each value over 256 chars becomes {omitted_bytes, see}, where see names the route that returns the full event. A report body_md over 6,000 chars becomes the same stub; a brief body_md is cut at 6,000 chars and ends in an ellipsis; llm_spend.calls holds the newest 10 calls, and calls_omitted counts the rest. A done, node-addressed run also carries record (its OpenMaterials SimulationRecord), openmaterials_url (the datasheet link) and openmaterials_label: null, or the commons' note when the record cites a model, configuration or code that is not in the public registry (record.unregistered lists each model and configuration), so its values cannot be checked against the commons. A campaign parent's summary.campaign holds its round, step, ceiling_tokens, committed_tokens, measured_tokens, finish, counts (children per state), children (every open child and the newest 8 settled ones, each with run_id) and children_omitted; GET /api/runs/:id lists every child. Its children are charged in the parent's one capture, so a child shows charged_tokens 0 and hold parent.

Fetch a study (the project a quote's study named) with its member simulations and their latest runs. Pass study_id or the exact name. Returns study, members (each with app_url) and app_url.

List runs, newest first: every run of this key's owner, or one quote's runs when quote_id is given. Returns at most limit rows (default 20, maximum 100). Each row carries state, spend_tokens, created_by_key_name (null when launched in the browser), study, headline (the AI brief's first line) and app_url. Returns runs and next_before: pass next_before as before to get the next older page; it is null on the last page.

Price a simulation. FREE: no hardware starts. Returns quote_id, quote_hash, tokens, rate_card_version, wall_s, expires_at, resource_class, resource_label and sku (the GPU class the quote is bound to, its name, and the offer SKU it priced; null when none was chosen), resource_options (one row per class the run can rent at this venue: resource_class, label, sku, tokens, wall_s, available; tokens and wall_s are what this quote would be on that class, null when it has no live offer now; re-quote with resource_class to pick one), pricing {hours_factor, potential_cost_ratio, note} when a potential staged at slots/potential was priced by its predicted per-step cost over the default's (the hours, the wall time and the run's wall limit are multiplied by hours_factor, at least 1, the factor on the quote's resource_class: each resource_options row is priced at its own class's factor; the per-second rate is unchanged), the plan, and record: {traced: true, node, node_uid, map_version (the openmaterials graph version the node is pinned at; the commons map version is published at openmaterials.ai/data/version.json), material (the material the pinned conditions name: what the run computes), potential {label, sha256} when the run's staged potential is not NEP89} when the completed run's OpenMaterials record is keyed on that public map node (measured instances cite the method that ran), else {traced: false, reason}, which only the graph arm, research coordinators and the untraced preview kinds (the reason is the kind's traced_note) return: a kind-arm spec no record can name is refused with the reason, and one naming several materials or interfaces carries detail.split: one {material, spec} per simulation, each ready to quote (pass the same study to group them). Research coordinators remain traced:false because they have no single public-node pin, but add record.record_contract: per-task omai completion requirements and the approved contract_sha256. Scientific tasks require simulation records; source-integrity QA requires node-less light_evidence, not scientific results. This is a required contract, not evidence that a run has completed; read it before you spend. The price is a binding ceiling: never more than this. A quote with billing.policy metered_v1 (D-083) carries billing {billing_mode, rate_tokens_per_s, boot_tokens, gate_tokens_per_stage, laws, liability_table, waiver_remaining_today, statement, dispute}: a metered run pays the lower of its work and its time, and a refusal the liability table names as the caller's, after the code computed, pays its work, never more than the quote. mcg_run accepts only this quote_id with this quote_hash before expires_at and REJECTS a stale hash (quote_mismatch) or an expired quote (quote_expired). Arms, exactly one: kind from mcg_catalog (spec passed through verbatim, spec.params set the price, engine overrides the default only with a known engine id); external_frontier, an OpenMaterials external-solve envelope from mcg_catalog's graphs (also returns request_id, plan_digest and the compiled plan; an envelope not byte-equal to a supported graph REJECTS with unsupported_graph); draft_id (see the parameter). Also returns app_url, the owner's page in the app (for the human, never fetched by the agent) and, on the kind arm, warnings: the inputs the app cannot render without (material or structure_xyz, study); pass them. key_cap {tokens, daily_token_cap, message} appears when the quote alone is above this key's daily_token_cap: mcg_run with this key would be refused.

The public rate card: token_usd, overheads, rate_card_version. FREE, no arguments; also a connectivity check.

Launch the quoted simulation. SPENDS TOKENS: provisions hardware and bills the account. Requires the quote_id and quote_hash from mcg_quote (a stale hash or an expired quote REJECTS: re-quote and retry) and a client-generated idempotency_key (replaying it returns the existing run instead of launching twice). Optional max_tokens is a hard ceiling: a quote above it REJECTS the launch, never clamps. Returns run_id.

Create a DRAFT simulation whose input files are uploaded before pricing. FREE. Takes the same kind, spec, study, material and conditions as mcg_quote plus inputs: one entry per file the run needs, each with a name and, for small text files, the text inline (staged immediately). Entries without text come back in uploads as presigned PUT URLs (valid 15 minutes, 4 GiB per file): upload each with a plain HTTP PUT of the file bytes, no key or header. Then call mcg_quote with draft_id to price; it REJECTS with inputs_missing until every declared input has arrived.

Add simulations to a study and remove them from it. You must own the study (get its id from mcg_get_study) and every listed simulation; a missing one is named and nothing changes. add appends in order (a member already present keeps its place); remove takes a simulation out of this study only, and the simulation and its runs are untouched. Joining a public study is refused for a run that cannot be public. Any change takes an auto-grouped study out of auto-grouping. Returns study, added, removed (the ids that changed), member_simulation_ids (unarchived members, in order), archived_member_ids and app_url.