Banners Job 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

job_id

string

optional

Include either job_id for querying a single job's status or tags for querying the status of multiple jobs associated with those tags. Do not include both in the same request.

job_labels

array[string]

optional

Retrieve jobs by their assigned job_labels. Note: You can specify either a job_id or job_labels for the query.

start

integer

optional

Retrieve the results from given start index

Default:

limit

integer

optional

Maximum results to retrieve.

>= 1<= 100

Default:

Example

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

Responses

🟢200Success

application/json

Body

jobs

array [object {3}]

required

An array of job objects, each representing the status of a specific job or jobs associated with specified tags.

job_id

string

required

The unique identifier for the job.

status

enum<string>

required

The current status of the job.

Allowed values:

pendingprocessingcompletedfailed

job_labels

array[string]

required

An array of associated job_labels to this job.

results

array [object {2}]

required

output_image_url

string

required

The URL to the output image, available only if the job is completed successfully.

crop_coordinates

object

required

error_message

string

required

An error message, provided if the job has failed.

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

Request

Request samples

Responses