Print Prepress
Substrates, imposition specs, preflight reports, prepress operations and artwork files.
103 operations · complete schema 325 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
getProductTemplate
Fetch a product template by ID. Requires productTemplate:read permission.
listProductTemplates
List product templates with optional filters, sorted by name. Requires productTemplate:list permission.
listProductTemplateVersions
List published versions of a template with pagination. Requires productTemplate:read permission.
getProductTemplateVersion
Fetch a specific published version. Requires productTemplate:read permission.
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.
getFile
Fetch a file by ID. Requires file:read permission.
listFiles
List files with pagination and filtering. Requires file:list permission.
getS3Backend
Fetch one storage backend as an S3 backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not S3 — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getHostPathBackend
Fetch one storage backend as a host-path backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not host-path — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getFTPBackend
Fetch one storage backend as an FTP backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not FTP — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getGoogleDriveBackend
Fetch one storage backend as a Google Drive backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not Google Drive — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getDropboxBackend
Fetch one storage backend as a Dropbox backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not Dropbox — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getStorageBackend
Fetch one storage backend by id. Null when no backend with that id exists in the caller's tenant. Requires storageBackend:read permission.
listStorageBackends
List the calling tenant's storage backends. Requires storageBackend:list permission.
storageCapabilities
Which storage backend kinds this deployment supports, so a client can hide unusable options. Requires storageBackend:list permission.
folder
A single folder in the caller's tenant, or null when no folder with that id exists there. Requires folder:read permission.
folders
Folders in the caller's tenant, filtered and sorted, as a connection. Requires folder:list permission.
getComponentArtworkFile
Fetch a component artwork file reference by ID. Requires componentArtworkFile:read permission.
listComponentArtworkFiles
List artwork file references for a component. Requires componentArtworkFile:list permission.
getImpositionSpec
Fetch an imposition spec by ID. Requires impositionSpec:read permission.
listImpositionSpecs
List imposition specs for a component. Requires impositionSpec:list permission.
previewImposition
Preview imposition layout without creating records. Used for estimation when no component exists yet.
listFoldPatterns
List all available fold patterns from the catalog. Requires authentication.
getPrepressOperation
Fetch a prepress operation by ID. Requires prepressOperation:read permission.
listPrepressOperations
List prepress operations for a component. Requires prepressOperation:list permission.
getPreflightReport
Fetch a preflight report by ID. Requires preflightReport:read permission.
listPreflightReports
List preflight reports for a component. Requires preflightReport:list permission.
renderArtworkPreview
Render a page of an artwork file to a JPEG preview (base64). Requires componentArtworkFile:read permission.
preflightCheck
Run preflight on supplied PDF bytes inline (not persisted). Requires preflightReport:read permission.
renderPreview
Render a page of supplied PDF bytes to a JPEG preview (base64) inline. Requires componentArtworkFile:read permission.
renderPlateSeparation
Render a single ink separation (plate) of an artwork page to a grayscale PNG (base64). Requires componentArtworkFile:read permission.
renderSeparation
Render a single ink separation (plate) from supplied PDF bytes to a grayscale PNG (base64) inline. Requires componentArtworkFile:read permission.
extractProduction
Extract ISO 19593-1 production steps from supplied PDF bytes inline (not persisted) — inspect before creating Operations. Requires operation:read permission.
getSubstrate
Fetch a substrate by ID. Requires substrate:read permission.
getSubstrateBy
Fetch a substrate by external ID. Requires substrate:read permission.
listSubstrates
List substrates with pagination and filtering. Requires substrate:list permission.
getSubstrateTemplateLine
Fetch a single substrate template line by ID. Requires substrateTemplateLine:read permission.
listSubstrateTemplateLines
List substrate template lines for a product template. Requires substrateTemplateLine:list permission.
upsertProductTemplate
Create or update a product template. Requires productTemplate:write permission.
createProductTemplate
Create a new product template. Requires productTemplate:write permission.
updateProductTemplate
Update a product template. Only provided fields are changed. Requires productTemplate:write permission.
deleteProductTemplate
Delete a product template. Requires productTemplate:delete permission.
publishProductTemplate
Publish a product template version. Requires productTemplate:write permission.
upsertFile
Create or update an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
createFile
Create an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
updateFile
Update a file. Only provided fields are changed. Requires file:write permission.
deleteFile
Delete a file. Requires file:delete permission.
requestFileUploads
Allocate one or more cloud upload URLs. Requires file:write permission.
completeFileUploads
Mark one or more uploads as ready. Requires file:write permission.
fileDownloadUrl
Resolve a download URL. Managed cloud URLs are provider-signed; EXTERNAL URLs pass through unchanged with no Pulse signature or TTL, and report URLs require authentication at retrieval. Requires file:download permission.
createStorageBackendAuthorization
Start the OAuth consent flow for a Google Drive or Dropbox backend. Persists a draft backend (status NEEDS_REAUTHORIZATION) and returns the provider consent URL to send the user to; the callback completes the draft. Requires storageBackend:write permission.
upsertStorageBackend
Create or update a storage backend in one call. Prefer createStorageBackend / updateStorageBackend, which have the same validation but distinct create/update semantics. Requires storageBackend:write permission.
createStorageBackend
Create a new storage backend. Requires storageBackend:write permission.
updateStorageBackend
Update a storage backend. Only provided fields are changed. Requires storageBackend:write permission.
deleteStorageBackend
Delete a storage backend. Returns a notFound payload when no such backend exists in the caller's tenant. Also the way to clean up a draft left behind by an abandoned OAuth flow. Requires storageBackend:delete permission.
testStorageBackend
Probe a storage backend's connectivity with its stored credentials (a bucket/root head — nothing is written). Never throws: a failure comes back as ok: false with a reason. Requires storageBackend:read permission.
createFolder
Creates a folder in the caller's tenant. The binding reference must resolve to a storage backend or controller owned by the tenant, the name must be unique within it, and at most one folder may be the tenant default. Requires folder:write permission.
updateFolder
Patches a folder. Omitted fields are left unchanged. A folder that files already reference may not have its binding or root path changed (stored file handles would resolve against the wrong transport/prefix), and the tenant default may be moved to another folder but never simply unset. Requires folder:write permission.
deleteFolder
Deletes a folder. Refused for the tenant default folder and for any folder still referenced by files — the stored bytes would be orphaned. Requires folder:delete permission.
testFolder
Checks a folder transport with a read-only stat probe. CONTROL_CLOUD reports UNKNOWN because its sentinel probe cannot verify tenant storage provisioning or remote reachability. Other bindings accept an absent sentinel as reachable; this does not test write permissions. Nothing is written, and no folder state changes. Requires folder:read permission.
upsertComponentArtworkFile
Add or update an artwork file reference on a component. Requires componentArtworkFile:write permission.
deleteComponentArtworkFile
Remove an artwork file reference from a component. Requires componentArtworkFile:delete permission.
upsertImpositionSpec
Add or update an imposition spec on a component. Requires impositionSpec:write permission.
deleteImpositionSpec
Remove an imposition spec from a component. Requires impositionSpec:delete permission.
imposePdfInline
Compose real source PDF pages using a previously calculated signature plan. Returns PDF bytes without persistence or cloud storage; does not calculate geometry or repeat forms by quantity. Requires impositionSpec:execute permission and the native PDF-Writer backend.
calculateImposition
Calculate imposition layout for a component and create ImpositionSpec records. Finished size, bleed, page count, and quantity are read from the component. Requires impositionSpec:write permission.
renderImpositionSVG
Render an imposition layout as SVG. Provide either impositionSpecId or layoutJSON. Requires impositionSpec:execute permission.
consolidateImpositionFinishing
Derive the consolidated per-kind finishing (cut-file) view from an imposed plan's per-cell finishing. Read-only. Provide either impositionSpecId or layoutJSON. Requires impositionSpec:execute permission.
upsertPrepressOperation
Create or update a prepress operation on a component. Requires prepressOperation:write permission.
deletePrepressOperation
Delete a prepress operation. Requires prepressOperation:delete permission.
upsertPreflightReport
Create or update a preflight report on a component. Requires preflightReport:write permission.
deletePreflightReport
Delete a preflight report. Requires preflightReport:delete permission.
runPreflight
Run the PrepressKit preflight engine on an artwork file and persist the report. Requires preflightReport:write permission.
extractProductionOperations
Extract ISO 19593-1 production steps from an artwork file and derive Operations (optionally persisting them). Requires operation:write permission.
instantiateProductTemplate
Instantiate a published product template into a print job. Requires productTemplate:execute permission.
installCanonicalTemplate
Install a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.
createSubstrate
Create a new substrate, failing if the code is already taken. Requires substrate:write permission.
updateSubstrate
Update a substrate in place. Only provided fields are changed. Requires substrate:write permission.
upsertSubstrate
Create or update a substrate. Requires substrate:write permission.
deleteSubstrate
Delete a substrate. Requires substrate:delete permission.
createSubstrateTemplateLine
Create a new substrate template line. Requires substrateTemplateLine:write permission.
updateSubstrateTemplateLine
Update a substrate template line in place. Only provided fields are changed. Requires substrateTemplateLine:write permission.
upsertSubstrateTemplateLine
Create or update a substrate template line. Requires substrateTemplateLine:write permission.
deleteSubstrateTemplateLine
Delete a substrate template line. Requires substrateTemplateLine:delete permission.
updatePaperWeightSettings
Saves the paper weight section. Other sections are untouched.
updateImposingSettings
Saves the imposing section. Other sections are untouched.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.