Crop.photo
  1. Crop.photo API
Crop.photo
  • Crop.photo API
    • Introduction
    • Authentication
    • FAQs
    • Examples
    • Interactive API Testing
    • Auto Resize & Align
      POST
    • Body Aware Crop
      POST
    • Unrecognizable Crop
      POST
    • Remove Background
      POST
    • Create Banner Job
      POST
    • AI Lifestyle Crop
      POST
    • Banners Job Status
      POST
  1. Crop.photo API

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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://us1-api.crop.photo/v1/banners/with-mask/status' \
--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
Previous
AI Lifestyle Crop
Built with