Banners Job Status
Developing
POST
/banners/with-mask/status
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
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
job_labels
. Note: You can specify either a job_id or job_labels for the query.start
integer
optional
start
indexDefault:
0
limit
integer
optional
>= 1<= 100
Default:
20
Example
{
"job_id": "string",
"job_labels": [
"car-model-lot-1"
],
"start": 0,
"limit": 20
}
Request 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
jobs
array [object {3}]
required
job_id
string
required
status
enum<string>
required
Allowed values:
pendingprocessingcompletedfailed
job_labels
array[string]
required
results
array [object {2}]
required
output_image_url
string
required
crop_coordinates
object
required
error_message
string
required
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