@transloadit/zod 4.5.0 → 5.0.0

package/dist/v4/robots/_instructions-primitives.d.ts

@@ -74,6 +74,7 @@ export declare const robotNames: z.ZodEnum<{
     DropboxImportRobot: "DropboxImportRobot";
     DropboxStoreRobot: "DropboxStoreRobot";
     HttpImportRobot: "HttpImportRobot";
+    HttpRequestRobot: "HttpRequestRobot";
     SftpImportRobot: "SftpImportRobot";
     SftpStoreRobot: "SftpStoreRobot";
     FtpImportRobot: "FtpImportRobot";
@@ -96,9 +97,9 @@ export declare const robotNames: z.ZodEnum<{
     TextSpeakRobot: "TextSpeakRobot";
     TextTranslateRobot: "TextTranslateRobot";
     FilePreviewRobot: "FilePreviewRobot";
+    TusStoreRobot: "TusStoreRobot";
     TransloaditImportRobot: "TransloaditImportRobot";
     TransloaditStoreRobot: "TransloaditStoreRobot";
-    TusStoreRobot: "TusStoreRobot";
     ProgressSimulateRobot: "ProgressSimulateRobot";
 }>;
 export declare const robotMetaSchema: z.ZodObject<{
@@ -177,6 +178,7 @@ export declare const robotMetaSchema: z.ZodObject<{
         DropboxImportRobot: "DropboxImportRobot";
         DropboxStoreRobot: "DropboxStoreRobot";
         HttpImportRobot: "HttpImportRobot";
+        HttpRequestRobot: "HttpRequestRobot";
         SftpImportRobot: "SftpImportRobot";
         SftpStoreRobot: "SftpStoreRobot";
         FtpImportRobot: "FtpImportRobot";
@@ -199,9 +201,9 @@ export declare const robotMetaSchema: z.ZodObject<{
         TextSpeakRobot: "TextSpeakRobot";
         TextTranslateRobot: "TextTranslateRobot";
         FilePreviewRobot: "FilePreviewRobot";
+        TusStoreRobot: "TusStoreRobot";
         TransloaditImportRobot: "TransloaditImportRobot";
         TransloaditStoreRobot: "TransloaditStoreRobot";
-        TusStoreRobot: "TusStoreRobot";
         ProgressSimulateRobot: "ProgressSimulateRobot";
     }>;
     priceFactor: z.ZodNumber;
@@ -213,6 +215,7 @@ export declare const robotMetaSchema: z.ZodObject<{
     minimumChargeUsdPerSpeechTranscribeMinute: z.ZodOptional<z.ZodObject<{
         aws: z.ZodNumber;
         gcp: z.ZodNumber;
+        replicate: z.ZodOptional<z.ZodLiteral<"variable">>;
     }, z.core.$strip>>;
     minimumChargeUsdPerDocumentOcrPage: z.ZodOptional<z.ZodObject<{
         aws: z.ZodNumber;
@@ -235,20 +238,13 @@ export declare const robotMetaSchema: z.ZodObject<{
     }>;
     importRanges: z.ZodOptional<z.ZodArray<z.ZodString>>;
     extraChargeForImageResize: z.ZodOptional<z.ZodNumber>;
-    bytescount: z.ZodNumber;
     description: z.ZodOptional<z.ZodString>;
-    discount_factor: z.ZodNumber;
-    discount_pct: z.ZodNumber;
-    example_code: z.ZodOptional<z.ZodAny>;
+    example_code: z.ZodOptional<z.ZodUnknown>;
     example_code_description: z.ZodOptional<z.ZodString>;
     extended_description: z.ZodOptional<z.ZodString>;
     has_small_icon: z.ZodOptional<z.ZodLiteral<true>>;
-    minimum_charge: z.ZodNumber;
-    minimum_charge_usd: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodRecord<z.ZodString, z.ZodNumber>]>>;
-    minimum_charge_usd_note: z.ZodOptional<z.ZodString>;
     ogimage: z.ZodOptional<z.ZodString>;
     marketing_intro: z.ZodOptional<z.ZodString>;
-    output_factor: z.ZodNumber;
     override_lvl1: z.ZodOptional<z.ZodString>;
     purpose_sentence: z.ZodString;
     purpose_verb: z.ZodEnum<{
@@ -256,7 +252,6 @@ export declare const robotMetaSchema: z.ZodObject<{
         split: "split";
         merge: "merge";
         extract: "extract";
-        remove: "remove";
         "auto-rotate": "auto-rotate";
         "cache & deliver": "cache & deliver";
         compress: "compress";
@@ -285,6 +280,7 @@ export declare const robotMetaSchema: z.ZodObject<{
         transcribe: "transcribe";
         translate: "translate";
         verify: "verify";
+        remove: "remove";
         write: "write";
         stream: "stream";
     }>;
@@ -303,19 +299,18 @@ export declare const robotMetaSchema: z.ZodObject<{
         "file-filtering": "file-filtering";
         "file-importing": "file-importing";
         "handling-uploads": "handling-uploads";
-        "image-manipulation": "image-manipulation";
+        "image-processing": "image-processing";
         "media-cataloging": "media-cataloging";
         "video-encoding": "video-encoding";
     }>;
-    slot_count: z.ZodNumber;
     title: z.ZodString;
     typical_file_size_mb: z.ZodNumber;
     typical_file_type: z.ZodEnum<{
+        image: "image";
+        file: "file";
         "audio file": "audio file";
         "audio or video file": "audio or video file";
         document: "document";
-        file: "file";
-        image: "image";
         video: "video";
         webpage: "webpage";
     }>;
@@ -325,22 +320,202 @@ export declare const robotMetaSchema: z.ZodObject<{
     }>>>;
 }, z.core.$strip>;
 export type RobotMetaInput = z.input<typeof robotMetaSchema>;
+/** Shared processing metadata; per-Robot exceptions stay explicit. */
+export declare const robotProcessingMeta: {
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    queueSlotCount: number;
+    priceFactor: number;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared artificial-intelligence metadata; exceptions stay local. */
+export declare const robotArtificialIntelligenceMeta: {
+    service_slug: "artificial-intelligence";
+    typical_file_type: "image";
+    trackOutputFileSize: true;
+    typical_file_size_mb: number;
+    queueSlotCount: number;
+    priceFactor: number;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared audio-encoding metadata; exceptions stay local. */
+export declare const robotAudioEncodingMeta: {
+    override_lvl1: string;
+    service_slug: "audio-encoding";
+    typical_file_size_mb: number;
+    typical_file_type: "audio file";
+    priceFactor: number;
+    queueSlotCount: number;
+    trackOutputFileSize: true;
+    applyCommunityPlanMediaTrim: true;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared document-processing metadata; exceptions stay local. */
+export declare const robotDocumentProcessingMeta: {
+    override_lvl1: string;
+    service_slug: "document-processing";
+    typical_file_size_mb: number;
+    typical_file_type: "document";
+    minimumCharge: number;
+    queueSlotCount: number;
+    priceFactor: number;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared content-delivery metadata; exceptions stay local. */
+export declare const robotContentDeliveryMeta: {
+    service_slug: "content-delivery";
+    queueSlotCount: number;
+    downloadInputFiles: false;
+    preserveInputFileUrls: true;
+    isAllowedForUrlTransform: false;
+    trackOutputFileSize: false;
+    isInternal: true;
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    priceFactor: number;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared file-filtering metadata; exceptions stay local. */
+export declare const robotFileFilteringMeta: {
+    override_lvl1: string;
+    service_slug: "file-filtering";
+    trackOutputFileSize: true;
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    queueSlotCount: number;
+    priceFactor: number;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared media-cataloging metadata; exceptions stay local. */
+export declare const robotMediaCatalogingMeta: {
+    override_lvl1: string;
+    service_slug: "media-cataloging";
+    queueSlotCount: number;
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    priceFactor: number;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared image-processing metadata; exceptions stay local. */
+export declare const robotImageProcessingMeta: {
+    override_lvl1: string;
+    service_slug: "image-processing";
+    typical_file_size_mb: number;
+    typical_file_type: "image";
+    queueSlotCount: number;
+    priceFactor: number;
+    isAllowedForUrlTransform: true;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared code-evaluation metadata; exceptions stay local. */
+export declare const robotCodeEvaluationMeta: {
+    override_lvl1: string;
+    service_slug: "code-evaluation";
+    isAllowedForUrlTransform: false;
+    trackOutputFileSize: true;
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    queueSlotCount: number;
+    priceFactor: number;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared video-encoding metadata; exceptions stay local. */
+export declare const robotVideoEncodingMeta: {
+    override_lvl1: string;
+    service_slug: "video-encoding";
+    typical_file_size_mb: number;
+    typical_file_type: "video";
+    queueSlotCount: number;
+    isAllowedForUrlTransform: false;
+    trackOutputFileSize: true;
+    applyCommunityPlanMediaTrim: true;
+    priceFactor: number;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Shared import metadata; provider-specific prices, queues, and flags override it locally. */
+export declare const robotImportMeta: {
+    override_lvl1: string;
+    purpose_verb: "import";
+    service_slug: "file-importing";
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    priceFactor: number;
+    queueSlotCount: number;
+    isAllowedForUrlTransform: true;
+    trackOutputFileSize: false;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: true;
+    stage: "ga";
+};
+/** Shared store metadata; provider-specific prices, queues, and flags override it locally. */
+export declare const robotStoreMeta: {
+    override_lvl1: string;
+    purpose_verb: "export";
+    service_slug: "file-exporting";
+    typical_file_size_mb: number;
+    typical_file_type: "file";
+    priceFactor: number;
+    queueSlotCount: number;
+    isAllowedForUrlTransform: true;
+    trackOutputFileSize: false;
+    isInternal: false;
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false;
+    stage: "ga";
+};
+/** Single-Step processing example; unusual input relationships stay explicit. */
+export declare function createProcessingExample(name: string, robot: string, parameters?: Record<string, unknown>): {
+    steps: Record<string, Record<string, unknown>>;
+};
+interface StorageExampleStep {
+    robot: string;
+    credentials: string;
+    path: string;
+    recursive?: true;
+    use?: ':original';
+}
+interface StorageRobotExample {
+    steps: Record<string, StorageExampleStep>;
+}
+/** Standard directory import example; nonrecursive providers omit the flag. */
+export declare function createStorageImportExample(robot: string, credentials: string, recursive?: boolean): StorageRobotExample;
+/** Standard export example shared by compatible storage providers. */
+export declare function createStorageStoreExample(robot: string, credentials: string): StorageRobotExample;
 export declare const interpolationSchemaFull: z.ZodCustom<`\${${string}}`, `\${${string}}`>;
 export declare const interpolationSchemaPartial: z.ZodCustom<string, string>;
 export declare const booleanStringSchema: z.ZodEnum<{
-    false: "false";
     true: "true";
+    false: "false";
 }>;
-export declare const inputSortBySchema: z.ZodDefault<z.ZodEnum<{
-    auto: "auto";
-    basename: "basename";
-    import_order: "import_order";
-}>>;
 type InterpolatableTuple<Schemas extends readonly z.core.SomeType[]> = Schemas extends readonly [
     infer Head extends z.core.SomeType,
     ...infer Rest extends z.core.SomeType[]
 ] ? [InterpolatableSchema<Head>, ...InterpolatableTuple<Rest>] : Schemas;
-type InterpolatableSchema<Schema extends z.core.SomeType> = Schema extends z.ZodString ? Schema : Schema extends z.ZodBoolean | z.ZodEnum<infer _Enum> | z.ZodLiteral<infer _Literal> | z.ZodNumber | z.ZodPipe<z.ZodTypeAny, z.ZodTypeAny> ? z.ZodUnion<[z.ZodString, Schema]> : Schema extends z.ZodArray<infer T> ? z.ZodUnion<[z.ZodString, z.ZodArray<InterpolatableSchema<T>>]> : Schema extends z.ZodDefault<infer T> ? z.ZodDefault<InterpolatableSchema<T>> : Schema extends z.ZodNullable<infer T> ? z.ZodNullable<InterpolatableSchema<T>> : Schema extends z.ZodOptional<infer T> ? z.ZodOptional<InterpolatableSchema<T>> : Schema extends z.ZodRecord<infer Key, infer Value> ? z.ZodRecord<Key, InterpolatableSchema<Value>> : Schema extends z.ZodTuple<infer T, infer Rest> ? z.ZodUnion<[
+type InterpolatableSchema<Schema extends z.core.SomeType> = Schema extends z.ZodString ? Schema : Schema extends z.ZodBoolean | z.ZodEnum<infer _Enum> | z.ZodLiteral<infer _Literal> | z.ZodNumber | z.ZodPipe<z.ZodTypeAny, z.ZodTypeAny> ? z.ZodUnion<[z.ZodString, Schema]> : Schema extends z.ZodArray<infer T> ? z.ZodUnion<[z.ZodString, z.ZodArray<InterpolatableSchema<T>>]> : Schema extends z.ZodDefault<infer T> | z.ZodPrefault<infer T> ? z.ZodPrefault<InterpolatableSchema<T>> : Schema extends z.ZodNullable<infer T> ? z.ZodNullable<InterpolatableSchema<T>> : Schema extends z.ZodOptional<infer T> ? z.ZodOptional<InterpolatableSchema<T>> : Schema extends z.ZodRecord<infer Key, infer Value> ? z.ZodRecord<Key, InterpolatableSchema<Value>> : Schema extends z.ZodTuple<infer T, infer Rest> ? z.ZodUnion<[
     z.ZodString,
     z.ZodTuple<InterpolatableTuple<T>, Rest extends z.core.SomeType ? InterpolatableSchema<Rest> : null>
 ]> : Schema extends z.ZodObject<infer T, infer Config> ? z.ZodUnion<[
@@ -349,7 +524,8 @@ type InterpolatableSchema<Schema extends z.core.SomeType> = Schema extends z.Zod
         [Key in keyof T]: InterpolatableSchema<T[Key]>;
     }, Config>
 ]> : Schema extends z.ZodDiscriminatedUnion<infer _T> ? Schema : Schema extends z.ZodUnion<infer T> ? z.ZodUnion<[z.ZodString, ...InterpolatableTuple<T>]> : Schema;
-export declare function interpolateRecursive<Schema extends z.core.SomeType>(schema: Schema): InterpolatableSchema<Schema>;
+/** Keep parameter help on rebuilt interpolation schemas. */
+export declare function interpolateRecursive<Schema extends z.ZodTypeAny>(schema: Schema): InterpolatableSchema<Schema>;
 /**
  * The robot keys specified in this array can’t be interpolated.
  */
@@ -359,27 +535,136 @@ type InterpolatableRobot<Schema extends z.ZodObject> = Schema extends z.ZodObjec
 }, Config> : never;
 export declare function interpolateRobot<Schema extends z.ZodObject>(schema: Schema): InterpolatableRobot<Schema>;
 export declare const robotInterpolateSchema: z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-    false: "false";
     true: "true";
-}>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
     false: "false";
+}>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
     true: "true";
-}>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>;
+    false: "false";
+}>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>;
 /**
  * Fields that are shared by all Transloadit robots.
  */
 export declare const robotOutputMetaSchema: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>;
 export type RobotOutputMeta = z.infer<typeof robotOutputMetaSchema>;
+export declare const autoProviderDescription = "Chooses the best provider based on your request.";
+export declare const robotParameterDocs: {
+    readonly adaptive_filtering: {
+        readonly description: "\nControls the image compression for PNG images. Setting to `true` results in smaller file size, while increasing processing time. It is encouraged to keep this option disabled.\n";
+    };
+    readonly ai_provider: {
+        readonly description: "Chooses the best provider based on your request.\n\nSelect a specific provider to override automatic selection.";
+    };
+    readonly audio_bitrate: {
+        readonly description: "\nBit rate of the resulting audio file, in bits per second. If not specified will default to the bit rate of the input audio file.\n";
+    };
+    readonly audio_preset: {
+        readonly description: "\nPerforms conversion using pre-configured settings.\n\nIf you specify your own FFmpeg parameters using the <dfn>Robot</dfn>'s `ffmpeg` parameter and you have not specified a preset, then the default `mp3` preset is not applied. This is to prevent you from having to override each of the MP3 preset's values manually.\n\nFor a list of audio presets, see [audio presets](/docs/presets/audio/).\n";
+    };
+    readonly audio_sample_rate: {
+        readonly description: "\nSample rate of the resulting audio file, in Hertz. If not specified will default to the sample rate of the input audio file.\n";
+    };
+    readonly auto_provider: {
+        readonly description: "Chooses the best provider based on your request.";
+    };
+    readonly error_msg: {
+        readonly description: "\nThe error message shown to your users (such as by Uppy) when a file is declined and `error_on_decline` is set to `true`.\n";
+    };
+    readonly error_on_decline: {
+        readonly description: "\nIf this is set to `true` and one or more files are declined, the Assembly will be stopped and marked with an error.\n";
+    };
+    readonly ffmpeg: {
+        readonly description: "\nA parameter object to be passed to FFmpeg. If a preset is used, the options specified are merged on top of the ones from the preset. For available options, see the [FFmpeg documentation](https://ffmpeg.org/ffmpeg-doc.html). Options specified here take precedence over the preset options.\n";
+    };
+    readonly ffmpeg_stack: {
+        readonly description: `
+Selects the FFmpeg stack version to use for encoding. We currently recommend using "v7". The exact versions ${string} are legacy values that remain accepted for backward compatibility. Deprecated ${string} values are also accepted.
+`;
+    };
+    readonly force_accept: {
+        readonly description: "Force a Robot to accept a file type it would have ignored.\n\nBy default, Robots ignore files they are not familiar with.\n[🤖/video/encode](/docs/robots/video-encode/), for\nexample, will happily ignore input images.\n\nWith the `force_accept` parameter set to `true`, you can force Robots to accept all files thrown at them.\nThis will typically lead to errors and should only be used for debugging or combatting edge cases.\n";
+    };
+    readonly force_name: {
+        readonly description: "Custom name for the imported file(s). By default file names are derived from the source.";
+    };
+    readonly ignore_errors: {
+        readonly description: "\nIgnore errors during specific phases of processing.\n\nSetting this to `[\"meta\"]` will cause the Robot to ignore errors during metadata extraction.\n\nSetting this to `[\"execute\"]` will cause the Robot to ignore errors during the main execution phase.\n\nSetting this to `true` is equivalent to `[\"meta\", \"execute\"]` and will ignore errors in both phases.\n";
+    };
+    readonly import_ignore_errors: {
+        readonly description: "\nIgnore errors during specific phases of processing.\n\nSetting this to `[\"meta\"]` will cause the Robot to ignore errors during metadata extraction.\n\nSetting this to `[\"execute\"]` will cause the Robot to ignore errors during the main execution phase.\n\nSetting this to `[\"import\"]` will cause the Robot to ignore errors while importing the source file. The `\"import\"` phase is only available to import Robots.\n\nSetting this to `true` is equivalent to `[\"meta\", \"import\", \"execute\"]` and will ignore errors in all three phases.\n";
+    };
+    readonly import_on_errors: {
+        readonly description: "\nSetting this to `[\"meta\"]` will still import the file on metadata extraction errors. `ignore_errors` is similar, it also ignores the error and makes sure the Robot doesn't stop, but it doesn't import the file.\n";
+    };
+    readonly interpolate: {
+        readonly description: "\nControls whether Assembly Variables are interpolated for individual instruction fields.\n\nBy default, most Robot instruction fields interpolate Assembly Variables. Set this to `false` to treat every instruction field as literal text, or set an individual field path to `false` to treat only that field as literal text. For Robot-specific fields that are literal by default, set this to `true` or set that field path to `true` to opt back into interpolation.\n\nUse field names such as `path`, or dotted paths such as `ffmpeg.vf` for nested objects.\n";
+    };
+    readonly ocr_format: {
+        readonly description: "\nIn what format to return the extracted text.\n- `\"json\"` returns a JSON file.\n- `\"meta\"` does not return a file, but stores the data inside Transloadit's file object (under `${file.meta.recognized_text}`, which is an array of strings) that's passed around between encoding <dfn>Steps</dfn>, so that you can use the values to burn the data into videos, filter on them, etc.\n- `\"text\"` returns the recognized text as a plain UTF-8 encoded text file.\n";
+    };
+    readonly ocr_granularity: {
+        readonly description: "\nWhether to return a full response including coordinates for the text (`\"full\"`), or a flat list of the extracted phrases (`\"list\"`). This parameter has no effect if the `format` parameter is set to `\"text\"`.\n";
+    };
+    readonly ocr_provider: {
+        readonly description: "Chooses the best provider based on your request.\n\nSelect a specific provider to override automatic selection.\nAWS supports detection for the following languages: English, Arabic, Russian, German, French, Italian, Portuguese and Spanish. GCP allows for a wider range of languages, with varying levels of support which can be found on the [official documentation](https://cloud.google.com/vision/docs/languages/).\n";
+    };
+    readonly output_meta: {
+        readonly description: "\nAllows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.\n\nFor images, you can add `\"has_transparency\": true` in this object to extract if the image contains transparent parts and `\"dominant_colors\": true` to extract an array of hexadecimal color codes from the image.\n\nFor images, you can also add `\"blurhash\": true` to extract a [BlurHash](https://blurha.sh) string — a compact representation of a placeholder for the image, useful for showing a blurred preview while the full image loads.\n\nFor images, `\"thumbhash\": true` instead extracts a base64-encoded [ThumbHash](https://evanw.github.io/thumbhash/) into `meta.thumbhash`, together with `meta.has_alpha` (whether an alpha channel exists, even when fully opaque). It describes EXIF-oriented pixels and uses the first frame of animated images. Extraction is best-effort: images above 40 megapixels, unsupported formats, or a failed/bounded decode produce no placeholder. Successful extraction adds a metadata charge equivalent to 20% of that file's bytes. No ThumbHash surcharge applies when disabled or when no hash is produced.\n\nSet this option on the Step producing the image, such as `/upload/handle` for uploaded originals or `/image/resize` for processed outputs. Setting it only on `/transloadit/store` does not request extraction: storage preserves the producer's metadata. Transloadit Storage persists a generated hash with its immutable version and returns it in stored results and native asset reads. Direct S3 uploads do not generate placeholders. A placeholder contains image information, so protect it with the same access controls as the full image.\n\nFor videos, you can add the `\"colorspace\": true` parameter to extract the colorspace of the output video.\n\nFor videos, you can also add `\"interlaced\": true` to detect whether the video is interlaced. This combines the cheap ffprobe `field_order` flag with a bounded `idet` sampling pass over the first frames of the source, exposing `interlaced`, `field_order`, and a diagnostic `interlace_detection` object under `file.meta`. This is computationally expensive and billed accordingly.\n\nFor audio, you can add `\"mean_volume\": true` to get a single value representing the mean average volume of the audio file.\n\nYou can also set this to `false` to skip metadata extraction and speed up transcoding.\n";
+    };
+    readonly queue: {
+        readonly description: "Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times";
+    };
+    readonly result: {
+        readonly description: "Whether the results of this Step should be present in the Assembly Status JSON";
+    };
+    readonly return_file_stubs: {
+        readonly description: "\nIf set to `true`, the Robot will not yet import the actual files but instead return an empty file stub that includes a URL from where the file can be imported by subsequent Robots. This is useful for cases where subsequent Steps need more control over the import process, such as with 🤖/video/ondemand. This parameter should only be set if all subsequent Steps use Robots that support file stubs.\n";
+    };
+    readonly robot: {
+        readonly description: "\nSpecifies which Robot should process files passed to this Step.\n\nSee [all Robots](https://transloadit.com/docs/robots/), each with their own parameters, such as\n`width` to control how an image is resized. The full list of parameters per Robot can be taken\nfrom the Robot docs.\n";
+    };
+    readonly seed: {
+        readonly description: "Seed for the random number generator.";
+    };
+    readonly sort_by: {
+        readonly description: "\nControls how bundled inputs are ordered when no explicit numbered alias for the input type is used. Numbered aliases end with a numeric suffix such as `_1`.\n\nThe default `\"basename\"` keeps the legacy natural basename sorting behavior.\n\nSet this to `\"import_order\"` to preserve the order of array-based import steps when all input files carry complete import order metadata. `\"auto\"` has the same import-order preference with natural basename sorting as fallback.\n";
+    };
+    readonly use: {
+        readonly description: "\nSpecifies which Step(s) to use as input.\n\n- You can pick any names for Steps except `\":original\"` (reserved for user uploads handled by Transloadit)\n- You can provide several Steps as input with arrays:\n  ```json\n  {\n    \"use\": [\n      \":original\",\n      \"encoded\",\n      \"resized\"\n    ]\n  }\n  ```\n- You can also tag input Steps with `as` to pass semantic intent to robots:\n  ```json\n  {\n    \"use\": [\n      {\n        \"name\": \":original\",\n        \"as\": \"image\"\n      },\n      {\n        \"name\": \":original\",\n        \"as\": \"mask\"\n      }\n    ]\n  }\n  ```\n\n> [!Tip]\n> That's likely all you need to know about `use`, but you can view [Advanced use cases](/docs/topics/use-parameter/).\n";
+    };
+    readonly user_meta: {
+        readonly description: "\nAdds custom JSON metadata to each emitted file without changing its contents. Nested objects and arrays are supported.\n\nInheritance depends on the Robot. Values merge with existing `user_meta` on the output file; the current Step replaces matching top-level keys. Assign required keys explicitly when a Robot creates fresh outputs.\n\nIn processing Steps, `${file.*}` refers to the first input and `${result.*}` to the emitted file. Values are evaluated per output after the Robot runs, before subsequent metadata extraction and temporary storage. On `:original`, values are evaluated per upload before metadata extraction.\n\nDownstream Steps read `${file.user_meta.key}`. See [Custom metadata](https://transloadit.com/docs/topics/assembly-variables/#user-meta) for a complete example and inheritance rules.\n";
+    };
+    readonly video_background: {
+        readonly description: "\nThe background color of the resulting video in the `\"rrggbbaa\"` format (red, green, blue, alpha) when used with the `\"pad\"` resize strategy. The default color is black.\n";
+    };
+    readonly video_height: {
+        readonly description: "\nHeight of the new video, in pixels.\n\nIf the value is not specified and the `preset` parameter is available, the `preset`'s [supplied height](/docs/presets/video/) will be implemented.\n";
+    };
+    readonly video_preset: {
+        readonly description: "\nConverts a video according to [pre-configured settings](/docs/presets/video/).\n\nYou can use the value `'empty'` here if you specify your own FFmpeg parameters using the <dfn>Robot</dfn> or do not want Transloadit to set any encoding settings.\n";
+    };
+    readonly video_width: {
+        readonly description: "\nWidth of the new video, in pixels.\n\nIf the value is not specified and the `preset` parameter is available, the `preset`'s [supplied width](/docs/presets/video/) will be implemented.\n";
+    };
+};
+export type RobotParameterDocId = keyof typeof robotParameterDocs;
+export declare const inputSortBySchema: z.ZodDefault<z.ZodEnum<{
+    auto: "auto";
+    basename: "basename";
+    import_order: "import_order";
+}>>;
+export declare const robotPathSchema: z.ZodString;
 export type RobotBase = z.infer<typeof robotBase>;
 export declare const robotBase: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
@@ -390,6 +675,76 @@ export declare const robotBase: z.ZodObject<{
         execute: "execute";
     }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>>;
 }, z.core.$strict>;
+/**
+ * Standard variants for strict Robot instructions without catchalls. Keep this outside the adapter
+ * replaced by the SDK's Zod 4 sync. Inference uses the active Zod version's object types.
+ */
+export declare function createRobotSchemaVariants<Shape extends z.ZodRawShape & {
+    result: z.ZodType;
+}>(schema: z.ZodObject<Shape>): {
+    schema: z.ZodObject<Shape, z.core.$strip>;
+    withHiddenFields: z.ZodObject<(keyof Shape & "result" extends never ? Shape & {
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    } : { [K in keyof Shape as K extends "result" ? never : K]: Shape[K]; } & {
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    }) extends infer T ? { [k in keyof T]: T[k]; } : never, z.core.$strict>;
+    interpolatable: z.ZodObject<{ [Key in keyof Shape]: Key extends "robot" | "use" | "interpolate" ? Shape[Key] : InterpolatableSchema<Shape[Key]>; }, z.core.$strict>;
+    interpolatableWithHiddenFields: z.ZodObject<((keyof Shape & "result" extends never ? Shape & {
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    } : { [K in keyof Shape as K extends "result" ? never : K]: Shape[K]; } & {
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    }) extends infer T_2 ? { [k in keyof T_2]: T_2[k]; } : never) extends infer T_1 extends Readonly<{
+        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    }> ? { [Key_1 in keyof T_1]: Key_1 extends "robot" | "use" | "interpolate" ? T_1[Key_1] : InterpolatableSchema<T_1[Key_1]>; } : never, z.core.$strict>;
+};
+/** Standard strict variants with extra internal fields. */
+export declare function extendRobotSchemaVariants<Shape extends z.ZodRawShape & {
+    result: z.ZodType;
+}, HiddenShape extends z.ZodRawShape>(schema: z.ZodObject<Shape>, hiddenFields: HiddenShape): {
+    schema: z.ZodObject<Shape, z.core.$strip>;
+    withHiddenFields: z.ZodObject<(keyof Shape & ("result" | keyof HiddenShape) extends never ? Shape & ({
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    } & HiddenShape extends infer T_1 ? { -readonly [P in keyof T_1]: T_1[P]; } : never) : { [K in keyof Shape as K extends "result" | keyof HiddenShape ? never : K]: Shape[K]; } & (({
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    } & HiddenShape extends infer T_3 ? { -readonly [P in keyof T_3]: T_3[P]; } : never) extends infer T_2 extends z.core.util.SomeObject ? { [K_1 in keyof T_2]: T_2[K_1]; } : never)) extends infer T ? { [k in keyof T]: T[k]; } : never, z.core.$strict>;
+    interpolatable: z.ZodObject<{ [Key in keyof Shape]: Key extends "robot" | "use" | "interpolate" ? Shape[Key] : InterpolatableSchema<Shape[Key]>; }, z.core.$strict>;
+    interpolatableWithHiddenFields: z.ZodObject<((keyof Shape & ("result" | keyof HiddenShape) extends never ? Shape & ({
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    } & HiddenShape extends infer T_6 ? { -readonly [P in keyof T_6]: T_6[P]; } : never) : { [K in keyof Shape as K extends "result" | keyof HiddenShape ? never : K]: Shape[K]; } & (({
+        result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, Shape["result"]]>>;
+    } & HiddenShape extends infer T_8 ? { -readonly [P in keyof T_8]: T_8[P]; } : never) extends infer T_7 extends z.core.util.SomeObject ? { [K_1 in keyof T_7]: T_7[K_1]; } : never)) extends infer T_5 ? { [k in keyof T_5]: T_5[k]; } : never) extends infer T_4 extends Readonly<{
+        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    }> ? { [Key_1 in keyof T_4]: Key_1 extends "robot" | "use" | "interpolate" ? T_4[Key_1] : InterpolatableSchema<T_4[Key_1]>; } : never, z.core.$strict>;
+};
+/**
+ * Named definition types keep the SDK's emitted declarations small. Robot modules explicitly
+ * reference their existing schema types instead of emitting another copy of each schema shape.
+ */
+export type RobotDefinition<Shape extends z.ZodRawShape & {
+    result: z.ZodType;
+}> = ReturnType<typeof createRobotSchemaVariants<Shape>> & {
+    meta: RobotMetaInput;
+};
+/** A Robot definition whose internal schema has additional fields. */
+export type RobotDefinitionWithHiddenFields<Shape extends z.ZodRawShape & {
+    result: z.ZodType;
+}, HiddenShape extends z.ZodRawShape> = ReturnType<typeof extendRobotSchemaVariants<Shape, HiddenShape>> & {
+    meta: RobotMetaInput;
+};
+/** Existing schema variants for Robots that require custom construction. */
+export interface RobotSchemaPair<PublicSchema, InternalSchema> {
+    meta: RobotMetaInput;
+    interpolatable: PublicSchema;
+    interpolatableWithHiddenFields: InternalSchema;
+}
+/** Define a strict Robot's schema variants together with its metadata. */
+export declare function defineRobot<Shape extends z.ZodRawShape & {
+    result: z.ZodType;
+}>(meta: RobotMetaInput, schema: z.ZodObject<Shape>): RobotDefinition<Shape>;
+/** Define a strict Robot with extra internal fields and its metadata. */
+export declare function defineRobotWithHiddenFields<Shape extends z.ZodRawShape & {
+    result: z.ZodType;
+}, HiddenShape extends z.ZodRawShape>(meta: RobotMetaInput, schema: z.ZodObject<Shape>, hiddenFields: HiddenShape): RobotDefinitionWithHiddenFields<Shape, HiddenShape>;
 export declare const useParamObjectSchema: z.ZodObject<{
     name: z.ZodString;
     fields: z.ZodOptional<z.ZodString>;
@@ -511,8 +866,8 @@ export declare const robotFFmpeg: z.ZodObject<{
         filter_complex: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
         'level:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
         'profile:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodEnum<{
-            main: "main";
             baseline: "baseline";
+            main: "main";
             high: "high";
             main10: "main10";
         }>]>>;
@@ -616,8 +971,8 @@ export declare const robotFFmpegAudio: z.ZodObject<{
         filter_complex: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
         'level:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
         'profile:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodEnum<{
-            main: "main";
             baseline: "baseline";
+            main: "main";
             high: "high";
             main10: "main10";
         }>]>>;
@@ -765,8 +1120,8 @@ export declare const robotFFmpegVideo: z.ZodObject<{
         filter_complex: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
         'level:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
         'profile:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodEnum<{
-            main: "main";
             baseline: "baseline";
+            main: "main";
             high: "high";
             main10: "main10";
         }>]>>;
@@ -1071,6 +1426,17 @@ export declare const next_page_token: z.ZodDefault<z.ZodString>;
 export declare const files_per_page: z.ZodDefault<z.ZodNumber>;
 export declare const page_number: z.ZodDefault<z.ZodNumber>;
 export declare const recursive: z.ZodDefault<z.ZodBoolean>;
+export declare const bucketImportPath: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+export declare const storeFilePath: z.ZodDefault<z.ZodString>;
+export declare const recursiveImportPageNumber: z.ZodDefault<z.ZodNumber>;
+export declare const signedSslUrlLifetime: z.ZodOptional<z.ZodNumber>;
+export declare const recursiveImportPageSize: z.ZodDefault<z.ZodNumber>;
+export declare const storePath: z.ZodDefault<z.ZodString>;
+export declare const storageAcl: z.ZodDefault<z.ZodEnum<{
+    private: "private";
+    "public-read": "public-read";
+}>>;
+export declare const recursiveImport: z.ZodDefault<z.ZodBoolean>;
 export declare const return_file_stubs: z.ZodDefault<z.ZodBoolean>;
 export declare const port: z.ZodNumber;
 export declare const preset: z.ZodString;
@@ -1095,11 +1461,14 @@ export declare const positionSchema: z.ZodEnum<{
 }>;
 export declare const percentageSchema: z.ZodString;
 export declare const httpUrlSchema: z.ZodString;
+/** Header restrictions shared by HTTP import and request documentation. */
+export declare const httpHeaderSafetyDescription = "Header names must be valid HTTP tokens. Header values may contain horizontal tabs, but other control characters, including carriage returns and line feeds, are rejected.\n\nIn an array of header strings, `\"Header-Name;\"` sends an empty header value. Each entry must be a literal header; reading headers from a file with `@filename` is not supported.";
 export declare const color_with_alpha: z.ZodString;
 export declare const color_without_alpha: z.ZodString;
+export declare const videoBackgroundSchema: z.ZodDefault<z.ZodString>;
 export declare const color_with_alpha_with_named: z.ZodUnion<readonly [z.ZodString, z.ZodEnum<{
-    none: "none";
     transparent: "transparent";
+    none: "none";
     black: "black";
     white: "white";
     red: "red";
@@ -1113,8 +1482,8 @@ export declare const color_with_alpha_with_named: z.ZodUnion<readonly [z.ZodStri
     opaque: "opaque";
 }>]>;
 export declare const color_without_alpha_with_named: z.ZodUnion<readonly [z.ZodString, z.ZodEnum<{
-    none: "none";
     transparent: "transparent";
+    none: "none";
     black: "black";
     white: "white";
     red: "red";
@@ -1129,10 +1498,10 @@ export declare const color_without_alpha_with_named: z.ZodUnion<readonly [z.ZodS
 }>]>;
 export declare const bitrateSchema: z.ZodNumber;
 export declare const sampleRateSchema: z.ZodNumber;
-export declare const optimize_priority: z.ZodDefault<z.ZodEnum<{
+export declare const optimize_priority: z.ZodEnum<{
     "compression-ratio": "compression-ratio";
     "conversion-speed": "conversion-speed";
-}>>;
+}>;
 export type ImagemagickRobot = z.infer<typeof robotImagemagick>;
 export declare const robotImagemagick: z.ZodObject<{
     imagemagick_stack: z.ZodDefault<z.ZodUnion<readonly [z.ZodEnum<{
@@ -1176,18 +1545,19 @@ export declare const colorspaceSchema: z.ZodEnum<{
     YPbPr: "YPbPr";
     YUV: "YUV";
 }>;
+export declare const imageAdaptiveFilteringSchema: z.ZodDefault<z.ZodBoolean>;
+export declare const imageQualityValueSchema: z.ZodNumber;
 export declare const imageQualitySchema: z.ZodDefault<z.ZodNumber>;
-export declare const autoProviderDescription = "Chooses the best provider based on your request";
 export declare const awsGcpAiProviderSchema: z.ZodDefault<z.ZodEnum<{
-    auto: "auto";
     aws: "aws";
     gcp: "gcp";
+    auto: "auto";
 }>>;
 export declare const aiProviderSchema: z.ZodDefault<z.ZodEnum<{
-    auto: "auto";
     aws: "aws";
     gcp: "gcp";
     replicate: "replicate";
+    auto: "auto";
     fal: "fal";
     transloadit: "transloadit";
 }>>;
@@ -1322,7 +1692,6 @@ export type SwiftBase = z.infer<typeof swiftBase>;
 export declare const swiftBase: z.ZodObject<{
     credentials: z.ZodOptional<z.ZodString>;
     bucket: z.ZodOptional<z.ZodString>;
-    bucket_region: z.ZodOptional<z.ZodString>;
     host: z.ZodOptional<z.ZodString>;
     key: z.ZodOptional<z.ZodString>;
     secret: z.ZodOptional<z.ZodString>;
@@ -1376,8 +1745,8 @@ export declare const videoEncodeSpecificInstructionsSchema: z.ZodObject<{
         filter_complex: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
         'level:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
         'profile:v': z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodEnum<{
-            main: "main";
             baseline: "baseline";
+            main: "main";
             high: "high";
             main10: "main10";
         }>]>>;
@@ -1733,5 +2102,21 @@ export interface NormalizedUse {
     group_by_original: boolean;
     steps: NormalizedUseStep[];
 }
+/** Public input and output types for a Robot's schema variants. */
+export type RobotSchemaVariantTypes<Variants extends {
+    schema: z.ZodType;
+    withHiddenFields: z.ZodType;
+    interpolatable: z.ZodType;
+    interpolatableWithHiddenFields: z.ZodType;
+}> = {
+    output: z.output<Variants['schema']>;
+    input: z.input<Variants['schema']>;
+    hiddenOutput: z.output<Variants['withHiddenFields']>;
+    hiddenInput: z.input<Variants['withHiddenFields']>;
+    interpolatableOutput: z.output<Variants['interpolatable']>;
+    interpolatableInput: z.input<Variants['interpolatable']>;
+    interpolatableHiddenOutput: z.output<Variants['interpolatableWithHiddenFields']>;
+    interpolatableHiddenInput: z.input<Variants['interpolatableWithHiddenFields']>;
+};
 export {};
 //# sourceMappingURL=_instructions-primitives.d.ts.map