Prepress
Files
Explore the data types and operations available in Files.
80 operations
Approve the exact configured From address, SMTP settings and current submission credential.
archiveInboxFolderMutationTerminally archive a mailbox, revoke its credentials, and preserve message/send evidence.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
completeFileUploadsMutationMark one or more uploads as ready. Requires file:write permission.
createFileMutationCreate an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
createFolderMutationCreates 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.
createInboxFolderMutationCreate a disabled mailbox configuration.
createStorageBackendMutationCreate a new storage backend. Requires storageBackend:write permission.
createStorageBackendAuthorizationMutationStart 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.
dataChangeEventsSubscriptionSubscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
deleteFileMutationDelete a file. Requires file:delete permission.
deleteFolderMutationDeletes 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.
deleteInboxFolderMutationRemove an empty archived configuration without deleting its storage Folder.
deleteStorageBackendMutationDelete 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.
dismissInboxDeliveryMutationDismiss a pending or paused delivery and release its pending content hold atomically.
enableInboxFolderMutationProbe retrieval credentials and storage capabilities, then enable retrieval from a no-backlog baseline.
fileDownloadUrlMutationResolve 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.
folderQueryA single folder in the caller's tenant, or null when no folder with that id exists there. Requires folder:read permission.
foldersQueryFolders in the caller's tenant, filtered and sorted, as a connection. Requires folder:list permission.
generateDefaultDataQueryQueryGenerate 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.
getDropboxBackendQueryFetch 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.
getFileQueryFetch a file by ID. Requires file:read permission.
getFTPBackendQueryFetch 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.
getGoogleDriveBackendQueryFetch 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.
getHostPathBackendQueryFetch 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.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getS3BackendQueryFetch 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.
getStorageBackendQueryFetch one storage backend by id. Null when no backend with that id exists in the caller's tenant. Requires storageBackend:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
holdInboxMessageMutationAcquire a bounded operator retention hold.
iacGuidesQueryEvery 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.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
inboxDeliveriesQueryKeyset page workflow delivery and execution status independently from intake status.
inboxFolderQueryRead a mailbox configuration in this tenant.
inboxFolderHealthQueryRead bounded mailbox runtime health without credentials or message content.
inboxFoldersQueryList mailbox configurations without credentials.
inboxMessageQueryRead accepted message metadata and managed File references under its InboxFolder permissions.
inboxMessageActivityQueryKeyset page durable review, inspection, hold, replay, and delivery-dismissal audit records.
inboxMessageContentQueryRead retained accepted MIME bytes with inbox, file, report, and Folder authorization.
inboxMessageHoldsQueryBounded tenant-scoped page of hold owners, reasons, and expiry state.
inboxMessagesQueryKeyset page mailbox intake/status records. Requires inboxFolder:list.
inboxOutboundStatusQueryRead safe outbound status for callers authorized to execute within the inbox.
inboxOutboundStatusesQueryKeyset page safe outbox statuses for authorized operators, including unknown deliveries.
inboxQuarantineInspectionQuerySeparately permissioned and audited access to bounded staged quarantine bytes; no File/Folder URL is exposed.
inboxRetentionPreviewQueryBounded sample of expired eligible and held messages, plus the next configured expiry.
inboxSenderAuthorizationQueryRead whether the current sender and submission credential have explicit operator approval.