The documentation build generates this page from _data/api-surface.json. Reachability does not imply public support.

Stable top-level exports

Export Owner
validate, validateProject Validation APIs
migrate Migration API
renderSnapshotToSvg, renderProjectToSvg Rendering APIs
assetIdFromFilename, resolveStateVisualAssetId State visual helpers
runCustomValidation, runCustomValidationInProcess Custom validation APIs
createPlaybackModel, resolveWorldStateAtTime Playback model APIs
getObjectAtTime, getObjectStateAtTime, getObjectLocationAtTime Playback model APIs
runtime Project execution

Compatibility top-level exports

Export Guidance
resolveObjectStateAtTime Use the playback model helpers for new integrations.

Internal top-level exports

The following reachable symbols have no public stability promise:

  • getStateLibrary
  • calculateLocationObjectSlots
  • parseDurationToMinutes
  • parseTaskStart
  • parseStrictTimeStringToMinutes
  • SUPPORTED_SCHEMA_VERSIONS
  • WORKSPEC_NAMESPACE
  • WORKSPEC_V2_SCHEMA_URL

Stable runtime exports

Export Owner
runtime.runProject Project execution
runtime.snapshotRunAt, runtime.snapshotProjectAt Snapshot APIs
runtime.runConstraintsOnResult Constraint execution APIs
runtime.serialiseState Types and data structures

Experimental runtime exports

Export Owner
runtime.analyzeChanges Tooling and analysis APIs

Internal runtime exports

The runtime namespace also exposes implementation helpers. They have no public stability promise.

  • runConstraints
  • parseDurationToMinutes, parseTaskStart, parseOffset
  • formatCompactReference, normalizeValueExpression, isValueReference
  • evaluateValue, evaluateCondition
  • buildIndex, resolveTimings, replay, snapshotAt
  • validate, validateSource
  • compileChanges, compileGenerator, applyChanges
  • seededRandom
  • OBJECT_FIELDS, TASK_FIELDS, LOCATION_FIELDS

See API stability and support policy before selecting an integration point.