Try On Job Cancel (Beta)

POST 
/v1/try-on/job/:jobId/cancel

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.

Request

Path Parameters

jobId stringrequired

The ID of the job to cancel

Responses

200

Job cancelled successfully

application/json

Schema

Schema

message string

Confirmation message

Example (from schema)

{
  "message": "Job cancelled"
}

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"
}

409

Job has already finished and cannot be canceled

application/json

Schema

Schema

error string
error_code string

Possible values: [job_finished]

Example (from schema)

{
  "error": "Job has already finished and cannot be canceled",
  "error_code": "job_finished"
}

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...