Cancel a running detached job

Stops the job, terminating its WHOLE process tree (a training run is rarely a single process) and releasing any GPU it had reserved. Cancelling a job that has already finished is not an error — you simply get its final state back. Cancellation is not reversible: work since the last checkpoint is lost, so confirm with the user before cancelling something long-running. For a job that is still alive the reply is not immediate: the endpoint waits a few seconds for the process tree to actually go, so that it reports what became of the job instead of its state before the signal was sent. Allow a client timeout of at least 10 seconds. If the job outlives that wait the reply says so explicitly — the cancellation was still accepted, so do not repeat it.

delete/api/v1/jobs/{id}

Request

  • Base URL: https://aicommander.dev
  • URL: https://aicommander.dev/api/v1/jobs/{id}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

idstring required
Example:9f2c1b7ad4e05386

The jobId returned by POST /api/v1/jobs (16 hex characters).

Query parameters

codestring required
Example:AIC-7K3P-WX9M-RTBN

How the user named the machine, passed exactly as given.

Response

The job's state after the call.

oktrue required

Example response

{
  "job": {
    "jobId": "9f2c1b7ad4e05386"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.