Batch API Reference

Batch image edit contract

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:

{
  "input": {
    "source": "storage://storage_1/input_folder/",
    "recursive": true
  },
  ...
}

In the Batch endpoint you could also set input as list of publicly accessible URLs, so our service can fetch and process them:

{
  "input": ["https://image.site/image.png", "https://image.site/image.png"],
  ...
}

Request image processing

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.

Process Batch Image Edit

Specifies:

• what images will be processed (input)
• how they will be processed (operations)
• where they will be stored (output)

POST/v1-beta1/image/edit/batch

Authorization

OAuth2PasswordBearerOAuth2PasswordBearer

Body

application/json

input*Input folder URL or list of image URLs

URL of the input file or folder. Should be from 1 to 512 characters. Must be accessible by our system.

image input optionsstring (uri)array of string (uri)

operations*Operations

Customize the editing workflow so that the output images meet your requirements.

outputOutput folder URL

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.

image output optionsstring (uri)

Response

200401402403422429

Successful Response

Body

application/json

dataBatchAcceptedResponse

Request

JavaScriptCurl

const response = await fetch('/v1-beta1/image/edit/batch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "input": "storage://storage_1/input_folder/ | https://image_url.com/example.jpg | [https://image_url.com/example.jpg, https://image_url.com/example.jpg]",
      "operations": {}
    }),
});
const data = await response.json();

Response

{
  "data": {
    "status": "ACCEPTED",
    "result_url": "https://example.com",
    "created_at": "2024-04-27T13:08:27.221Z",
    "request": {
      "input": "storage://storage_1/input_folder/ | https://image_url.com/example.jpg | [https://image_url.com/example.jpg, https://image_url.com/example.jpg]",
      "operations": {
        "restorations": {
          "decompress": {},
          "upscale": "smart_enhance",
          "polish": false
        },
        "resizing": {
          "fit": "cover"
        },
        "adjustments": {},
        "background": {
          "remove": false,
          "color": "text",
          "blur": false
        },
        "padding": "text",
        "privacy": {
          "blur_car_plate": false
        }
      },
      "output": "storage://storage_1/output_folder/"
    },
    "errors": [
      {
        "error": "text",
        "created_at": "text",
        "input_object": {
          "ext": "text",
          "mps": 0,
          "mime": "text",
          "format": "text"
        }
      }
    ],
    "results": [
      {
        "input_object": {
          "ext": "text",
          "mps": 0,
          "mime": "text",
          "format": "text"
        },
        "output_object": {
          "ext": "text",
          "mps": 0,
          "mime": "text",
          "format": "text",
          "tmp_url": "text",
          "object_key": "text",
          "object_bucket": "text",
          "object_uri": "text",
          "claid_storage_uri": "text",
          "gcs_key": "text",
          "gcs_bucket": "text"
        }
      }
    ]
  }
}

Request

HTTP

POST /v1-beta1/image/edit/batch HTTP/1.1
Host: api.claid.ai
Authorization: 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/"
}

cURL

curl -X POST --location "http://api.claid.ai/v1-beta1/image/edit/batch" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}" \
    -H "Content-Type: application/json" \
    -d "{
          \"input\": \"storage://storage_1/input_folder/\",
          \"operations\": {
            \"resizing\": {
              \"width\": 1000
            },
            \"background\": {
              \"remove\": false
            }
          },
          \"output\": \"storage://storage_1/output_folder/\"
        }"    -H "Authorization: Bearer {YOUR_API_KEY}"

Read a response

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.

Response body

{
  "data": {
    "id": 1,
    "status": "ACCEPTED",
    "result_url": "http://api.claid.ai/v1-beta1/image/edit/batch/1",
    "created_at": "2023-03-13T11:37:09.160554+00:00",
    "request": {
      "input": "storage://storage_1/input_folder/",
      "operations": {
        "resizing": {
            "width": 1000
        },
        "background": {
            "remove": false
        }
      },
      "output": "storage://storage_1/output_folder/"
    }
  }
}

See the Request Headers and Response Headers to learn about headers.

Result of request processing contract

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.

Image Edit Batch Async Results

GET/v1-beta1/image/edit/batch/{task_id}

Authorization

OAuth2PasswordBearer

Path parameters

task_id*Task Id

Response

200401403404422

Successful Response

Body

application/json

dataBatchResultResponse

Request

JavaScriptCurl

const response = await fetch('/v1-beta1/image/edit/batch/{task_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "status": "ACCEPTED",
    "result_url": "https://example.com",
    "created_at": "2024-04-27T13:08:27.221Z",
    "request": {
      "input": "storage://storage_1/input_folder/ | https://image_url.com/example.jpg | [https://image_url.com/example.jpg, https://image_url.com/example.jpg]",
      "operations": {
        "restorations": {
          "decompress": {},
          "upscale": "smart_enhance",
          "polish": false
        },
        "resizing": {
          "fit": "cover"
        },
        "adjustments": {},
        "background": {
          "remove": false,
          "color": "text",
          "blur": false
        },
        "padding": "text",
        "privacy": {
          "blur_car_plate": false
        }
      },
      "output": "storage://storage_1/output_folder/"
    },
    "errors": [
      {
        "error": "text",
        "created_at": "text",
        "input_object": {
          "ext": "text",
          "mps": 0,
          "mime": "text",
          "format": "text"
        }
      }
    ],
    "results": [
      {
        "input_object": {
          "ext": "text",
          "mps": 0,
          "mime": "text",
          "format": "text"
        },
        "output_object": {
          "ext": "text",
          "mps": 0,
          "mime": "text",
          "format": "text",
          "tmp_url": "text",
          "object_key": "text",
          "object_bucket": "text",
          "object_uri": "text",
          "claid_storage_uri": "text"
        }
      }
    ]
  }
}

Request

HTTP

GET /v1-beta1/image/edit/batch/1 HTTP/1.1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}

cURL

curl -X GET --location "http://api.claid.ai/v1-beta1/image/edit/batch/1" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}"

Read a response

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.

Image information shown in the response:

Parameter	Type	Description
id	integer	Task ID.
status	string	Request processing status. Can have values: ACCEPTED, PROCESSING, ERROR, DONE.
created_at	string	Exact time when the processing was requested.
request	object	The body of the request that was used for processing.
errors	list	List of errors, if any are occurred during image processing (status will have ERROR value), in other cases - will be empty.
results	list	List of results in form of input_object and output_object pairs, in case of processing errors - will be empty. Details are listed below.

See input_object and output_object properties description at the Read a response part of the Async endpoint page.

Response body

{
  "data": {
    "id": 1,
    "status": "DONE",
    "created_at": "2023-03-13T11:37:09.160554+00:00",
    "request": {
      "input": "storage://storage_1/input_folder/",
      "operations": {
        "resizing": {
            "width": 1000
        },
        "background": {
            "remove": false
        }
      },
      "output": "storage://storage_1/output_folder/"
    },
    "errors": [],
    "results": [
      {
        "input_object": {
          "ext": "pnj",
          "mps": 0.04,
          "mime": "image/jpeg",
          "format": "JPEG",
          "width": 200,
          "height": 200
        },
        "output_object": {
          "ext": "jpeg",
          "mps": 1.0,
          "mime": "image/jpeg",
          "format": "JPEG",
          "width": 1000,
          "height": 1000
        }
      },
      {
        "input_object": {
          "ext": "pnj",
          "mps": 0.09,
          "mime": "image/jpeg",
          "format": "JPEG",
          "width": 300,
          "height": 300
        },
        "output_object": {
          "ext": "jpeg",
          "mps": 1.0,
          "mime": "image/jpeg",
          "format": "JPEG",
          "width": 1000,
          "height": 1000
        }
      }
    ]
  }
}

See Response headers to learn about headers.