Try On Job Cancel (Beta)

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

Cancels a Try On job that is currently pending or running. When a Try On job is submitted with wait_for_result set to false, it can be cancelled using this endpoint if it hasn’t completed yet. Jobs that are already completed or failed cannot be cancelled.

POST /v1/try-on/job/{jobId}/cancel

Try On Job Cancel (Beta)

cURL

curl --request POST \
  --url https://api.developer.pixelcut.ai/v1/try-on/job/{jobId}/cancel \
  --header 'X-API-KEY: <api-key>'

200

{
  "message": "Job cancelled"
}

Authorizations

X-API-KEY · string · header · required

All API requests require a valid api key. Include your token as a HTTP request header in the following format: X-API-Key: skXXXXXXXXXXXXXXXX. You can obtain an api key by signing up for developer access in your Pixelcut account.

Path Parameters

jobId · string · required

The ID of the job to cancel

Response

200

application/json

Job cancelled successfully

message · string

Confirmation message

Example:

"Job cancelled"