Prepress

Files

Explore the data types and operations available in Files.

80 operations

approveInboxSenderMutation

Approve the exact configured From address, SMTP settings and current submission credential.

archiveInboxFolderMutation

Terminally archive a mailbox, revoke its credentials, and preserve message/send evidence.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

completeFileUploadsMutation

Mark one or more uploads as ready. Requires file:write permission.

createFileMutation

Create an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.

createFolderMutation

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.

createInboxFolderMutation

Create a disabled mailbox configuration.

createStorageBackendMutation

Create a new storage backend. Requires storageBackend:write permission.

createStorageBackendAuthorizationMutation

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.

dataChangeEventsSubscription

Subscribe 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).

deleteFileMutation

Delete a file. Requires file:delete permission.

deleteFolderMutation

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.

deleteInboxFolderMutation

Remove an empty archived configuration without deleting its storage Folder.

deleteStorageBackendMutation

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.

dismissInboxDeliveryMutation

Dismiss a pending or paused delivery and release its pending content hold atomically.

enableInboxFolderMutation

Probe retrieval credentials and storage capabilities, then enable retrieval from a no-backlog baseline.

fileDownloadUrlMutation

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.

folderQuery

A single folder in the caller's tenant, or null when no folder with that id exists there. Requires folder:read permission.

foldersQuery

Folders in the caller's tenant, filtered and sorted, as a connection. Requires folder:list permission.

generateDefaultDataQueryQuery

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.

getDropboxBackendQuery

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.

getFileQuery

Fetch a file by ID. Requires file:read permission.

getFTPBackendQuery

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.

getGoogleDriveBackendQuery

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.

getHostPathBackendQuery

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.

getMagicQueryGraphQLQuery

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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getS3BackendQuery

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.

getStorageBackendQuery

Fetch one storage backend by id. Null when no backend with that id exists in the caller's tenant. Requires storageBackend:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

holdInboxMessageMutation

Acquire a bounded operator retention hold.

iacGuidesQuery

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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

inboxDeliveriesQuery

Keyset page workflow delivery and execution status independently from intake status.

inboxFolderQuery

Read a mailbox configuration in this tenant.

inboxFolderHealthQuery

Read bounded mailbox runtime health without credentials or message content.

inboxFoldersQuery

List mailbox configurations without credentials.

inboxMessageQuery

Read accepted message metadata and managed File references under its InboxFolder permissions.

inboxMessageActivityQuery

Keyset page durable review, inspection, hold, replay, and delivery-dismissal audit records.

inboxMessageContentQuery

Read retained accepted MIME bytes with inbox, file, report, and Folder authorization.

inboxMessageHoldsQuery

Bounded tenant-scoped page of hold owners, reasons, and expiry state.

inboxMessagesQuery

Keyset page mailbox intake/status records. Requires inboxFolder:list.

inboxOutboundStatusQuery

Read safe outbound status for callers authorized to execute within the inbox.

inboxOutboundStatusesQuery

Keyset page safe outbox statuses for authorized operators, including unknown deliveries.

inboxQuarantineInspectionQuery

Separately permissioned and audited access to bounded staged quarantine bytes; no File/Folder URL is exposed.

inboxRetentionPreviewQuery

Bounded sample of expired eligible and held messages, plus the next configured expiry.

inboxSenderAuthorizationQuery

Read whether the current sender and submission credential have explicit operator approval.