Check one detached job

Returns the job's current state: running (the process was alive when the machine looked), exited (the exit code is authoritative — 0 is success), or unknown (the process is gone and no exit code was recorded — an agent restart, a SIGKILL, the OOM killer, an escalated cancellation, or any cancellation on Windows all land here, because no exit marker is ever written; the outcome is genuinely unknowable and must NEVER be reported as success). Poll at a sensible interval, e.g. every few minutes for a training run.

get/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). A malformed id answers 404, exactly like an unknown one.

Query parameters

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

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

include_command'true' | 'false'

Send true to also return the job's command line. Off by default.

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.