OSos3robotics
jobs

Cancel Job

Requests the job's cancellation (202); the job stops and moves to cancelled shortly after. 409 once its run has finished: an evaluating job is not stopped.

post/jobs/{job_id}/cancel

Request

  • Base URL
    https://api.os3robotics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.os3robotics.com/jobs/{job_id}/cancel
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

job_idstring uuid required

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
workspace_idstring uuid required
numberinteger required
dataset_version_idstring uuid required
image_digeststring required
state'queued' | 'provisioning' | 'running' | 'evaluating' | 'succeeded' | 'failed' | 'cancelled' required
agent_stepinteger required
attemptinteger required
errorstring nullable required
idempotency_keystring required
cancel_requested_atstring date-time nullable required
cancel_reasonstring nullable
queued_atstring date-time required
provisioning_atstring date-time nullable required
running_atstring date-time nullable required
finished_atstring date-time nullable required
pull_snumber nullable required
start_snumber nullable required
compile_snumber nullable required
runs_onstring[] nullable
waitingstring nullable
env_revision_idstring uuid nullable

An RL training job's environment revision: the exact revision of the environment catalog it trains in, qualified for training when the job was made.

fanout_idstring uuid nullable
allocation_idstring uuid nullable

The shared allocation the job trains in (a shared_lora fan-out): the job that holds its GPUs, whose logs show the allocation's own lines; null for a job with GPUs of its own.

pipeline_defaultsobject nullable

Changes

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