Batch endpoint allows batch processing of images by specifying a cloud Storage directory as input. See Storage overview for more info.
In other aspects, the Batch endpoint behaves like the Async endpoint, returning a response without waiting for an actual result that should be queried with another request.
By default, it is expected that the images will be located in the root of the cloud directory that is specified in the input field. To retrieve all images from subdirectories recursively, the input field should have the recursive parameter as following:
The request body for Batch endpoint is the same as for regular image edit operation, except Storage directories are allowed for input and output parameters. See Image edit contract for more info.
Request
POST /v1-beta1/image/edit/batch HTTP/1.1Host:api.claid.aiAuthorization:Bearer {YOUR_API_KEY}Content-Type:application/json{"input":"storage://storage_1/input_folder/","operations": {"resizing": {"width":1000 },"background": {"remove":false } },"output":"storage://storage_1/output_folder/"}
Once you have made the request to https://api.claid.ai/v1-beta1/image/edit/batch you will get a response with information about request status and other details, see the Read a response part of the Async endpoint page for more info.
To get Batch image editing result, you need to know the ID of the processing request. Or you can take a ready-to-use link from the result_url property of the response body described above.
Request
GET /v1-beta1/image/edit/batch/1 HTTP/1.1Host:api.claid.aiAuthorization:Bearer {YOUR_API_KEY}
Once you have made the request to https://api.claid.ai/v1-beta1/image/edit/batch/<task_id> you will get a response with information about the request, input, and output images.