Cancel a managed job

Request cancellation for active child trials without rewriting completed results.

POST /api/v1/users/{user_id}/harbor/jobs/{job_id}/cancel

Cancel a managed job

cURL

curl --request POST \
  --url https://sprites-gateway.api.synthlabs.ai/api/v1/users/{user_id}/harbor/jobs/{job_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "user_requested"
}
'

200

{
  "already_terminal_trials": 123,
  "cancelled_trials": 123,
  "conflict_trials": 123,
  "intended_trials": 123,
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "propagation_pending": 123,
  "reason": "<string>",
  "replayed": true,
  "requested_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Synth customer access token for the current user and organization.

Path Parameters

user_id · string<uuid> · required

job_id · string<uuid> · required

Body

application/json

Owner request to atomically cancel cancellable members of one hosted job.

reason · string · default: user_requested

Required string length: 1 - 512

Response

200

application/json

Frozen cancellation outcome, including idempotent replay.

Frozen replayable result of one authoritative hosted-job cancellation.

already_terminal_trials · integer · required

cancelled_trials · integer · required

conflict_trials · integer · required

intended_trials · integer · required

job_id · string<uuid> · required

propagation_pending · integer · required

reason · string · required

replayed · boolean · required

requested_at · string<date-time> · required