--- title: "Image Edit Batch Async Results" method: GET path: "/v1/image/edit/batch/{task_id}" tags: ["Image"] --- # Image Edit Batch Async Results `GET /v1/image/edit/batch/{task_id}` ## Request - The document declares no server URL. - Auth: OAuth 2 - Password - Token URL: `token` scopes: `image_editing` ## Path parameters - `task_id` integer, required ## Response `200` Successful Response - ResponseBatchResultResponse: Wrapper for responses - `data` BatchResultResponse - `id` integer, required - `status` 'ACCEPTED' | 'WAITING' | 'PROCESSING' | 'DONE' | 'ERROR' | 'CANCELLED' | 'PAUSED', required: An enumeration. - `result_url` string, uri - `created_at` string, date-time, required - `request` union, required - BatchEditRequest - `input` union, required: URL of the input file or folder. Should be from 1 to 512 characters. Must be accessible by our system. - BatchEditInputOptions - `source` string, uri, required: URL of the input file or folder. Should be from 1 to 512 characters. Must be accessible by our system. - `recursive` boolean: If `true`, recursively processes all images in subfolders as well, works only if source is folder. - string, uri - string[] - `operations` ImageOperations, required - `restorations` RestorationsOptions - `decompress` 'moderate' | 'strong' | 'auto': Selects the restoration mode. | Value | Description | | --- | --- | | `null` | DEFAULT. No restoration applied.| | `"moderate"` | Removes JPEG artifacts from the image.| | `"strong"` | Removes JPEG artifacts more aggressively than `"moderate"`.| | `"auto"` | Automatically detects and remove JPEG artifacts if needed.| - `upscale` union: The upscale operation allows you to improve the overall quality of an image by rendering out new pixels. The upscale operation works along with resizing through numeric or percentage values for upscaling. - … - `polish` boolean: If `true`, polishes an image - `adjustments` AdjustmentsOptions - `hdr` union: Balances out colors and lighting. Allows to turn on `stitching` for stitched 360 photos. - … - `exposure` integer: Decrease (negative integer) or increase (positive integer) exposure. - `saturation` integer: Decrease (negative integer) or increase (positive integer) saturation. - `contrast` integer: Decrease (negative integer) or increase (positive integer) contrast. - `sharpness` integer: Increase sharpness. - `background` BackgroundOptions - `remove` union: Allows to turn on and configure image background removal. - … - `color` union: Color as a hexadecimal. Sets a background color. Defaults to the `#ffffff` (white) color, or `transparent` if an input image has transparency. - … - `blur` union: Allows to turn on and configure image background blurring. - … - `resizing` ResizingOptions - `width` union: Width of output image. Should be of the same type as `height`, or `"auto"`. - … - `height` union: Height of output image. Should be of the same type as `width`, or `"auto"`. - … - `fit` union: The fit parameter controls how the image will be constrained within the provided size, relative to the `width` and `height`. By default, `fit` mode is `"crop"`. - … - `padding` string: Add a space around the object equally to each of 4 sides, or for height&width separately. Can not be bigger than half of image width/height. By default, padding is not applied. - `privacy` PrivacyOptions - `blur_car_plate` boolean: If `true`, blurs car plate. - `identity_crop` boolean: Removes a person's face from the image by cutting everything above the mouth. - `generative` GenerativeOptions - `style_transfer` StyleTransferOptions - … - `output` union: URL of the output folder. If `output` is not defined, we store the output image on our bucket and return the temporary URL. The name of the output file remains the same as the input file. Images are stored for one day. - ImageOutputOptions - `format` union: Converts an image to one of the following formats: `"jpeg"`, `"png"`, `"webp"`, `"avif"`. Selecting *Jpeg Options* allows to specify quality. - … - `destination` string, uri: URL of the output image. If `output` is not defined, we store the output image on our bucket and return the temporary URL. The name of the output file remains the same as the input file. Images are stored for one day. - `metadata` MetadataOptions - … - string, uri - AsyncEditRequest - `input` string, uri, required: URL of the input image. Should be from 1 to 512 characters. Image must be accessible by our system. - `operations` ImageOperations, required - `restorations` RestorationsOptions - `decompress` 'moderate' | 'strong' | 'auto': Selects the restoration mode. | Value | Description | | --- | --- | | `null` | DEFAULT. No restoration applied.| | `"moderate"` | Removes JPEG artifacts from the image.| | `"strong"` | Removes JPEG artifacts more aggressively than `"moderate"`.| | `"auto"` | Automatically detects and remove JPEG artifacts if needed.| - `upscale` union: The upscale operation allows you to improve the overall quality of an image by rendering out new pixels. The upscale operation works along with resizing through numeric or percentage values for upscaling. - … - `polish` boolean: If `true`, polishes an image - `adjustments` AdjustmentsOptions - `hdr` union: Balances out colors and lighting. Allows to turn on `stitching` for stitched 360 photos. - … - `exposure` integer: Decrease (negative integer) or increase (positive integer) exposure. - `saturation` integer: Decrease (negative integer) or increase (positive integer) saturation. - `contrast` integer: Decrease (negative integer) or increase (positive integer) contrast. - `sharpness` integer: Increase sharpness. - `background` BackgroundOptions - `remove` union: Allows to turn on and configure image background removal. - … - `color` union: Color as a hexadecimal. Sets a background color. Defaults to the `#ffffff` (white) color, or `transparent` if an input image has transparency. - … - `blur` union: Allows to turn on and configure image background blurring. - … - `resizing` ResizingOptions - `width` union: Width of output image. Should be of the same type as `height`, or `"auto"`. - … - `height` union: Height of output image. Should be of the same type as `width`, or `"auto"`. - … - `fit` union: The fit parameter controls how the image will be constrained within the provided size, relative to the `width` and `height`. By default, `fit` mode is `"crop"`. - … - `padding` string: Add a space around the object equally to each of 4 sides, or for height&width separately. Can not be bigger than half of image width/height. By default, padding is not applied. - `privacy` PrivacyOptions - `blur_car_plate` boolean: If `true`, blurs car plate. - `identity_crop` boolean: Removes a person's face from the image by cutting everything above the mouth. - `generative` GenerativeOptions - `style_transfer` StyleTransferOptions - … - `output` union: Customize the result output. - ImageOutputOptions - `format` union: Converts an image to one of the following formats: `"jpeg"`, `"png"`, `"webp"`, `"avif"`. Selecting *Jpeg Options* allows to specify quality. - … - `destination` string, uri: URL of the output image. If `output` is not defined, we store the output image on our bucket and return the temporary URL. The name of the output file remains the same as the input file. Images are stored for one day. - `metadata` MetadataOptions - … - string, uri - object - `errors` BatchPipelineError[] - `error` string, required - `created_at` string, required - `input_object` PipelineInputObjectInError - `ext` string, required: File extension. Can have values: `"jpg"`, `"png"`, `"avif"` - `mps` number, required: Megapixel count - `mime` string, required: MIME type (also known as ‘media type’) - `format` string, required: File format. Can have values: `"jpeg"`, `"png"`, `"avif"` - `width` integer, required: Image width in pixels - `height` integer, required: Image height in pixels - `results` AsyncPipelineResultItem[] - `input_object` PipelineInputObject, required - `ext` string, required: File extension. Can have values: `"jpg"`, `"png"`, `"avif"` - `mps` number, required: Megapixel count - `mime` string, required: MIME type (also known as ‘media type’) - `format` string, required: File format. Can have values: `"jpeg"`, `"png"`, `"avif"` - `width` integer, required: Image width in pixels - `height` integer, required: Image height in pixels - `output_object` PipelineOutputObject, required - `ext` string, required: File extension. Can have values: `"jpg"`, `"png"`, `"avif"` - `mps` number, required: Megapixel count - `mime` string, required: MIME type (also known as ‘media type’) - `format` string, required: File format. Can have values: `"jpeg"`, `"png"`, `"avif"` - `width` integer, required: Image width in pixels - `height` integer, required: Image height in pixels - `tmp_url` string: Temporal URL of a processed image - `object_key` string: Path to a processed image in a bucket - `object_bucket` string: Bucket name - `object_uri` string: URI of a processed image in a bucket - `claid_storage_uri` string: URI of a processed image in a storage ## Other responses - `401`: Authorization is required. - `403`: Not enough permissions. - `404`: Batch image edit pipeline not found. - `422`: Unprocessable Entity. ## Changes - **2026-11-03** `18c907f76458`: 1 info - endpoint added [Operation history](https://skmtc.dev/claid/apis/claid-rest-api/changes/v1/image/edit/batch/:task_id/get.md) --- [API](https://skmtc.dev/claid/apis/claid-rest-api.md) - [All operations](https://skmtc.dev/claid/apis/claid-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/claid/apis/claid-rest-api/revisions/18c907f76458?raw)