Cancel Augmentation Job
POST
/v1/augmentation/{job_id}/cancel
const url = 'https://example.com/v1/augmentation/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/augmentation/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancelCancel an augmentation job.
Stops the job if it’s still running and triggers credit finalization. Any unused credits from the reservation will be returned.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” job_id
required
Job Id
string format: uuid
Header Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”Augmentation job cancelled successfully
Media type application/json
AugmentationCancelResponse
Response after cancelling an augmentation job.
object
Example generated
{ "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cancelled": true, "message": "example"}Invalid or missing API key
Media type application/json
ErrorResponse
Standard error response.
object
detail
required
Detail
Error message describing what went wrong
string
Example generated
{ "detail": "example"}Augmentation job not found
Media type application/json
ErrorResponse
Standard error response.
object
detail
required
Detail
Error message describing what went wrong
string
Example generated
{ "detail": "example"}Validation error