Try On Job Status (Beta)

GET 
/v1/try-on/job/:jobId

BETA - This endpoint is currently in beta and may change without notice.

Checks the status of a Try On job. When using the Try On API with wait_for_result set to false, it returns a job ID. This endpoint allows you to check the status of that job and retrieve the final result when processing is complete.

Request

Path Parameters

jobId stringrequired

The ID of the job to check

Responses

200

Job status retrieved successfully

application/json

Schema

Schema

job_id string

The ID of the job

status string

Possible values: [pending, running, completed, failed]

The current status of the job

result_url string

A URL to access the resultant image, only present when status is 'completed'

error

object

message string

A description of the error.

error_code string

Possible values: [invalid_parameter, content_filter_error, request_timeout, job_expired, job_cancelled, unexpected_error, service_unavailable]

The error codes provide a way to programmatically handle errors.

The following error codes are currently in use:

• invalid_parameter: The request contained invalid parameters.
• content_filter_error: The content was flagged by our content filter.
• request_timeout: The request timed out while processing.
• job_expired: The job has expired and is no longer available.
• job_cancelled: The job was cancelled.
• unexpected_error: An unexpected error occurred during processing.
• service_unavailable: The service is temporarily unavailable.

Example (from schema)

{
  "job_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "status": "completed",
  "result_url": "https://assets.pixelcut.app/public/result/a16646be-91c8-4e3a-b359.jpg",
  "error": {
    "message": "Job processing failed",
    "error_code": "content_filter_error"
  }
}

400

The input could not be processed, often returned when the input image exceeds API limits.

application/json

Schema

Schema

error string

A description of the error.

error_code string
Possible values: [invalid_request_body, missing_parameter, invalid_parameter, unsupported_content_type, malformed_image, unsupported_image_format, file_size_too_large, resolution_too_high, unknown_foreground]
The error codes provide a way to programmatically handle errors.
The following error codes are currently in use:
• invalid_request_body: The request body was empty or invalid.
• missing_parameter: A required parameter was not provided.
• invalid_parameter: A parameter was provided but it was invalid.
• unsupported_content_type: The content type of the request was not application/json or multipart/form-data.
• malformed_image: The image could not be decoded.
• unsupported_image_format: The image format is not supported.
• file_size_too_large: The image file size is too large.
• resolution_too_high: The image resolution is too high.
• unknown_foreground: The foreground subject of the image could not be detected.

Example (from schema)

{
  "error": "File size too large",
  "error_code": "file_size_too_large"
}

401

The authentication token is missing or invalid.

application/json

Schema

Schema

error string
error_code string

Possible values: [invalid_auth_token]

Example (from schema)

{
  "error": "API Token not found",
  "error_code": "invalid_auth_token"
}

404

Job not found

application/json

Schema

Schema

error string
error_code string

Possible values: [not_found]

Example (from schema)

{
  "error": "Job not found",
  "error_code": "not_found"
}

429

Rate limit exceeded

application/json

Schema

Schema

error string
error_code string

Possible values: [rate_limit_exceeded]

Example (from schema)

{
  "error": "Too many requests",
  "error_code": "rate_limit_exceeded"
}

500

Internal service error

Loading...