Banners Job Status
DevelopingPOST/banners/with-mask/statusThis 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
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.
Retrieve jobs by their assigned job_labels. Note: You can specify either a job_id or job_labels for the query.
Retrieve the results from given start index
Maximum results to retrieve.
{
"job_id": "string",
"job_labels": [
"car-model-lot-1"
],
"start": 0,
"limit": 20
}Request samples
Responses
An array of job objects, each representing the status of a specific job or jobs associated with specified tags.
The unique identifier for the job.
The current status of the job.
An array of associated job_labels to this job.
The URL to the output image, available only if the job is completed successfully.
An error message, provided if the job has failed.
{
"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"
}