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.
Request
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: |
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
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.
Request
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: |
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 ( |
result | object | Result object that is contain 2 properties |
Read a input_object
and output_object
properties of response result
property:
Parameter | Type | Description |
---|---|---|
ext | string | File extension. Can have values: |
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: |
tmp_url | string | Temporary URL of a processed image. Is available only for |
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 |
Response body
See Response headers to learn about headers.
Last updated