Comment on page

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.
post
/v1-beta1/image/edit/async
Async Image Edit
Request body
POST /v1-beta1/image/edit/async HTTP/1.1
Host: api.claid.ai
Authorization: Bearer 12354567890
Content-Type: application/json
Content-Length: 174
​
{
  "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
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.
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.
get
/v1-beta1/image/edit/async/{task_id}
Async Image Edit Result
Request
GET /v1-beta1/image/edit/async/1 HTTP/1.1
Host: api.claid.ai
Authorization: Bearer 12354567890
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
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.
Read a input_object and output_object properties of response result property:
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.
Read an item from errors property:
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.
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.

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.

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.

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`.

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`.

Image Editing API - Previous

API Reference

Next - Image Editing API

Batch API Reference

Last modified 1mo ago