Async API Reference

Async image edit contract

Async endpoint returns a response without waiting for an actual result. The actual result should be queried with another request. So you can request image editing and separately get the result after it's ready.

Request image processing

The request body for async endpoint is the same as for regular image edit operation. See Image edit contract for more info.

Async Image Edit

Specifies:

what image will be processed (input)
how it will be processed (operations)
where it will be stored (output)

POST/v1-beta1/image/edit/async

Authorization

Body

input*Input URL

URL of the input image. Should be from 1 to 512 characters. Image must be accessible by our system.

operations*Operations

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

outputOutput

Customize the result output.

Response

Successful Response

Body

dataAsyncAcceptedResponse

Request

const response = await fetch('/v1-beta1/image/edit/async', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "input": "storage://storage_1/path/image.jpg",
      "operations": {}
    }),
});
const data = await response.json();

Response

{
  "data": {
    "status": "ACCEPTED",
    "result_url": "https://example.com",
    "created_at": "2024-04-19T23:57:51.947Z",
    "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"
        },
        "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"
        }
      }
    ],
    "result": {
      "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

POST /v1-beta1/image/edit/async HTTP/1.1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}
Content-Type: application/json

{
  "input": "https://picsum.photos/200.jpg",
  "operations": {
    "resizing": {
      "width": 1000
    },
    "background": {
      "remove": false
    }
  }
}

curl -X POST --location "http://api.claid.ai/v1-beta1/image/edit/async" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}" \
    -H "Content-Type: application/json" \
    -d "{
          \"input\": \"https://picsum.photos/200.jpg\",
          \"operations\": {
            \"resizing\": {
              \"width\": 1000
            },
            \"background\": {
              \"remove\": false
            }
          }
        }"

Read a response

Once you have made the request to https://api.claid.ai/v1-beta1/image/edit/async you will get a response with information about request status and some other details (listed below).

Request information shown in the response:

Parameter Type Description

Parameter	Type	Description
id	integer	Task ID.
status	string	Request processing status. For a valid requst can only have one value: `ACCEPTED`.
result_url	string	URL of GET endpoint that can be used to get the result manually and get request status while it is still in process.
created_at	string	Exact time when the processing was requested.
request	object	The body of the request that was used for processing.

integer

Task ID.

status

string

Request processing status. For a valid requst can only have one value: ACCEPTED.

result_url

string

URL of GET endpoint that can be used to get the result manually and get request status while it is still in process.

created_at

string

Exact time when the processing was requested.

request

object

The body of the request that was used for processing.

Response body

{
  "data": {
    "id": 1,
    "status": "ACCEPTED",
    "result_url": "http://api.claid.ai/v1-beta1/image/edit/async/1",
    "created_at": "2023-03-13T11:37:09.160554+00:00",
    "request": {
      "input": "https://picsum.photos/200.jpg",
      "operations": {
        "resizing": {
            "width": 1000
        },
        "background": {
            "remove": false
        }
      }
    }
  }
}

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

Result of request processing contract

To get 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.

Async Image Edit Result

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

Authorization

Path parameters

task_id*Task Id

Response

Successful Response

Body

dataAsyncResultResponse

Request

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

Response

{
  "data": {
    "status": "ACCEPTED",
    "result_url": "https://example.com",
    "created_at": "2024-04-19T23:57:51.947Z",
    "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"
        },
        "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"
        }
      }
    ],
    "result": {
      "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

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

curl -X GET --location "http://api.claid.ai/v1-beta1/image/edit/async/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/async/<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

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.
result	object	Result object that is contain 2 properties `input_object` and `output_object`, in case of processing errors - will be empty. Details are listed below.

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.

result

object

Result object that is contain 2 properties input_object and output_object, in case of processing errors - will be empty. Details are listed below.

Read a input_object and output_object properties of response result property:

Parameter Type Description

Parameter	Type	Description
ext	string	File extension. Can have values: `jpg`, `png`, `webp`, `av1`.
mps	float	Megapixel count.
mime	string	MIME type (also known as ‘media type’).
width	integer	Image width in pixels.
height	integer	Image height in pixels.
format	string	File format. Can have values: `jpeg`, `png`, `webp`, `avif`.
tmp_url	string	Temporary URL of a processed image. Is available only for `output_object`.

ext

string

File extension. Can have values: jpg, png, webp, av1.

mps

float

Megapixel count.

mime

string

MIME type (also known as ‘media type’).

width

integer

Image width in pixels.

height

integer

Image height in pixels.

format

string

File format. Can have values: jpeg, png, webp, avif.

tmp_url

string

Temporary URL of a processed image. Is available only for output_object.

Read an item from errors property:

Parameter Type Description

Parameter	Type	Description
error	string	Error message in text.
created_at	integer	Exact time when the error was catched.
input_object	object	Same as `input_object` from `result` property. For some errors can be `null`.

error

string

Error message in text.

created_at

integer

Exact time when the error was catched.

input_object

object

Same as input_object from result property. For some errors can be null.

Response body

{
  "data": {
    "id": 1,
    "status": "DONE",
    "created_at": "2023-03-13T11:37:09.160554+00:00",
    "request": {
      "input": "https://picsum.photos/200.jpg",
      "operations": {
        "resizing": {
            "width": 1000
        },
        "background": {
            "remove": false
        }
      }
    },
    "errors": [],
    "result": {
      "input_object": {
        "ext": "pnj",
        "mps": 0.016384,
        "mime": "image/jpeg",
        "format": "JPEG",
        "width": 128,
        "height": 128
      },
      "output_object": {
        "ext": "jpeg",
        "mps": 1.0,
        "mime": "image/jpeg",
        "format": "JPEG",
        "width": 1000,
        "height": 1000,
        "tmp_url": "https://storage.googleapis.com/production-leapi-tmp-public/000/200.jpeg"
      }
    }
  }
}

See Response headers to learn about headers.

PreviousAPI Reference NextBatch API Reference

Last updated 3 months ago