Prepress
Files
Explore the data types and operations available in Files.
86 types · Used in operation arguments and return values.
A keyset page of mailbox intake records.
InboxOperationResultObjectOutcome of an inbox runtime command.
InboxOutboundIDScalarOutbound reply sent from an inbox, prefix ibo.
InboxOutboundStatusObjectSafe outbound status and recipient outcome counts without MIME or recipient addresses.
InboxOutboundStatusPageObjectA keyset page of outbound statuses.
InboxProbeResultObjectRead-only mailbox connection probe.
InboxQuarantineInspectionObjectRaw staged quarantine bytes returned only by a separate audited, permissioned inspection operation.
InboxRetentionPreviewObjectBounded preview of what retention cleanup would remove or keep.
InboxSenderAuthorizationStatusObjectWhether a mailbox's sender settings have explicit operator approval.
IntScalarThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JSONScalarArbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.
MagicQueryInfoObjectA discoverable Magic Query noun and its accepted options.
MagicQueryOperationObjectThe real GraphQL operation + variables a Magic Query resolves to.
MagicQuerySchemaObjectInput (JSON Schema) and output (introspection) contract for a Magic Query noun.
MailboxCredentialPurposeEnumSupported MailboxCredentialPurpose values.
QueryScalarScalarA URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.
RequestFileUploadInputInputInput for allocating a cloud upload URL. uploadedByUserId is derived from the auth context.
RequestFileUploadsPayloadObjectResult of requesting one or more upload URLs
S3BackendObjectPublic projection of an S3 backend's configuration. Populated only when kind is S3. Credentials are elided; see hasCredentials.
StorageBackendConnectionObjectA page of the tenant's storage backends.
StorageBackendFilterInputInputFilter for listStorageBackends. Omitted fields impose no constraint.
StorageBackendIDScalarTypeID of a storage backend (`sbk_` prefix, e.g. "sbk_01K…"). Opaque to clients; the underlying row id never leaves the server.
StorageBackendOutputObjectA configured storage destination for a tenant (archives, transfers, folder bindings). Credentials are never returned; each backend kind's block exposes a hasCredentials flag instead.
StorageBackendProbeResultObjectOutcome of testStorageBackend: whether the backend is reachable right now, and why not if it isn't.
StorageBackendSortInputInputOne ordering rule for listStorageBackends. The argument takes a list, but only the first entry is applied.
StorageCapabilitiesOutputObjectWhich backend kinds this deployment can actually run, so a client can hide options that would only fail on submit.
StringScalarThe `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
TopicExampleObjectA validated example. JSON strings contain illustrative inputs and responses, never live customer data.
UpdateFileInputInputInput for updating a file. Only provided fields are changed.
UpdateFolderInputInputInput for updateFolder. A patch: every field except id is optional, and an omitted (null) field keeps its stored value rather than clearing it.
UpdateStorageBackendInputInputInput for updating a storage backend. Only provided fields are changed.
UpsertFileInputInputInput for creating or updating an external-backed file. Cloud-backed files go through requestFileUploads / completeFileUploads.
UpsertFilePayloadObjectResult of creating or updating a file
UpsertStorageBackendInputInputCreate-or-update input for a storage backend: creates when id is omitted, updates the named row when it is present. Flat by kind — the resolver promotes the matching fields into the kind's config, and ignores the others.
UpsertStorageBackendPayloadObjectResult of upsertStorageBackend: either the persisted backend, or the validation errors that rejected it.
WorkflowTriggerIDScalarUnique identifier for a workflow trigger