Journeys and Workspaces
Journey and workspace definitions and their versions.
56 operations · complete schema 106 KB
magicQuery
Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
getMagicQuerySchema
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
listMagicQueries
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
getMagicQueryGraphQL
Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
listDataChangeEventTopics
List all valid data change event topics, grouped by resource. Requires authentication.
generateDefaultDataQuery
Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
ping
Health check endpoint
analyzeJourneySource
Compile Journey XML without saving or executing steps.
getJourney
Fetch a single journey by ID, if the caller may see it.
getJourneyByHandle
Fetch a journey by its stable handle (deep links / anchored launches), if the caller may see it.
listJourneys
List the caller's visible journey library (own personal + their teams' + instance).
getJourneyVersion
Fetch one journey version by ID. Returns null when the journey is not visible to the caller, and when the version is still an open draft and the caller is not its author — matching what `listJourneyVersions` would show.
listJourneyVersions
List all versions of a journey, newest first (authoring history), if the caller may see it.
analyzeWorkspaceSource
Analyze Workspace XML and Lua without saving, executing handlers or querying business data. Requires Workspace authoring permission.
getWorkspace
Fetch a single workspace by ID, if the caller may see it.
getWorkspaceByHandle
Fetch a workspace by its stable handle (deep links / anchored launches), if the caller may see it.
listWorkspaces
List the caller's visible workspace library (own personal + their teams' + instance).
getWorkspaceSource
Author-only XML/Lua source envelope for one Workspace version. Compiler artifacts remain internal.
loadWorkspaceData
Runs a declared read-only Lua loader on the current published Workspace version; returns JSON.
getWorkspaceVersion
Fetch one workspace version by ID. Returns null when the workspace is not visible to the caller, and when the version is still an open draft and the caller is not its author — matching what `listWorkspaceVersions` would show.
listWorkspaceVersions
List all versions of a workspace, newest first (authoring history), if the caller may see it.
iacSchema
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacValidate
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
iacGuides
Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
helpChapters
List human-facing manual chapters from the running deployment.
helpChapter
Read a chapter of the current published manual edition.
searchHelp
Search human-facing manuals using shared semantic and text retrieval.
schemaAuthoringCatalog
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
compileSchemaXML
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
renderSchemaXML
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
iacSchemaDocument
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
deleteJourneyVersionIfExists
Delete a journey version using native authorization, succeeding when it is already absent for parent-owned cascade cleanup.
createJourneyFromSource
Compile authoritative Journey XML and create a journey using native scope-dependent authorization.
updateJourneyFromSource
Apply a revision-checked Journey XML or visibility edit while preserving fields omitted by the caller.
createJourneyVersionFromSource
Compile Journey XML into a new draft version under an existing journey, preserving prior versions.
upsertJourney
Create a journey or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
createJourney
Create a new journey. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
updateJourney
Patch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.
publishJourney
Promote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.
createJourneyVersion
Create a new draft version of a journey. Always mints a new version rather than amending an open draft, so several drafts may be open at once. Owner for PERSONAL, else journey:write.
deleteJourneyVersion
Delete one version from a journey's authoring history. Fails when the version is the one the journey is currently published at — delete the journey itself to remove that. Owner for PERSONAL, else journey:write.
deleteJourney
Delete a journey and all its versions. Owner for PERSONAL, else journey:write.
upsertWorkspace
Create a workspace or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
createWorkspace
Create a new workspace. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
updateWorkspaceSource
Revision-checked Workspace authoring update using native authorization and validation.
updateWorkspace
Update a workspace. Only provided fields are changed. Owner for PERSONAL, else workspace:write.
invokeWorkspaceAction
Runs a declared Lua action as the caller on the current published Workspace version; returns JSON.
publishWorkspace
Promote a named draft version of a workspace to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else workspace:write.
createWorkspaceVersionSnapshot
Create an immutable source snapshot for reviewed publication. Parent edits create another draft instead of changing this version. Uses native Workspace authorization and validation.
createWorkspaceVersion
Create a new draft version of a workspace. Always mints a new version rather than amending an open draft, so several drafts may be open at once. Owner for PERSONAL, else workspace:write.
deleteWorkspaceVersionIfExists
Idempotent cleanup retaining native scope authorization and published-version protection
deleteWorkspaceVersion
Delete one version from a workspace's authoring history. Fails when the version is the one the workspace is currently published at — delete the workspace itself to remove that. Owner for PERSONAL, else workspace:write.
deleteWorkspace
Delete a workspace and all its versions. Owner for PERSONAL, else workspace:write.
validateJourneyDefinition
Validate a journey definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires journey:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
validateWorkspaceDefinition
Validate a workspace definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires workspace:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.