Banners Job Status

Developing

POST

/banners/with-mask/status

This API endpoint provides the functionality to query the status of multiple photo cropping jobs using tags specified at the time of job submission. Users can retrieve a consolidated status report for all jobs matching the provided tags, enabling efficient tracking of related jobs.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "job_id": "string",
    "job_labels": [
        "car-model-lot-1"
    ],
    "start": 0,
    "limit": 20
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://us1-api.crop.photo/v1/banners/with-mask/status' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "job_id": "string",
    "job_labels": [
        "car-model-lot-1"
    ],
    "start": 0,
    "limit": 20
}'

Responses

🟢200Success

application/json

Body

Example

{
    "jobs": [
        {
            "job_id": "string",
            "status": "pending",
            "job_labels": [
                "string"
            ]
        }
    ],
    "results": [
        {
            "output_image_url": "string",
            "crop_coordinates": {
                "x": 0.1,
                "y": 0.2,
                "width": 0.4,
                "height": 0.4
            }
        }
    ],
    "error_message": "string"
}

🟠401Unauthorized

🟠400Invalid Input | Crop.photo

Modified at 2024-04-26 16:06:09

AI Lifestyle Crop

CreateBannerRequest