AGPL-3.0-or-later · forever.

{"id":"remote/jobs","slug":"jobs","section":"remote","label":"Jobs","summary":"Submit, poll, cancel and settle remote work.","status":"preview","docsPath":"https://docs.nika.sh/sdk/remote/jobs","eyebrow":"remote preview · jobs","title":"Submit, observe, settle.","description":"Use the jobs namespace for submission, status, cancellation, polling, event streaming and artifact collection.","promise":"The jobs API is already typed and fixture-tested. It remains a preview because the compatible workflow HTTP service is not part of the released engine.","facts":[{"label":"submit","value":"POST /v1/run"},{"label":"status","value":"GET /v1/status/:id"},{"label":"cancel","value":"POST /v1/cancel/:id"},{"label":"service","value":"not shipped"}],"sections":[{"label":"01 · submit","title":"Return the job identity immediately.","body":"submit is the low-latency form. Persist job_id before opening an event stream so reconnects and support tools share one identity.","code":"const { job_id } = await nika.jobs.submit(\n  'release.nika.yaml',\n  { channel: 'stable' },\n)","language":"typescript","filename":"submit.ts"},{"label":"02 · wait","title":"Use polling when progress is not visible.","body":"run submits and polls until a terminal status. Poll interval, timeout and backoff belong to client configuration.","code":"const job = await nika.jobs.run('release.nika.yaml')\nconsole.log(job.status, job.exit_code)","language":"typescript","filename":"wait.ts"},{"label":"03 · cancel","title":"Separate job cancellation from request abort.","body":"jobs.cancel asks the service to cancel work. AbortSignal stops the caller waiting on a request. Products often need both actions.","code":"await nika.jobs.cancel(job_id)\nconst settled = await nika.jobs.status(job_id)","language":"typescript","filename":"cancel-job.ts"},{"label":"04 · horizon","title":"Keep this behind an adapter.","body":"The namespace is useful for integration work, tests and UI design today. Do not route production work to it until a compatible service release is published."}],"related":[{"label":"Remote client","to":"/sdk/remote/client"},{"label":"SSE streaming","to":"/sdk/remote/streaming"},{"label":"Artifacts","to":"/sdk/remote/artifacts"},{"label":"Use LocalNika today","to":"/sdk/local/client"}]}

remote preview · jobs

Submit, observe, settle.

Use the jobs namespace for submission, status, cancellation, polling, event streaming and artifact collection.

The jobs API is already typed and fixture-tested. It remains a preview because the compatible workflow HTTP service is not part of the released engine.

Return the job identity immediately.

submit is the low-latency form. Persist job_id before opening an event stream so reconnects and support tools share one identity.

const { job_id } = await nika.jobs.submit(
  'release.nika.yaml',
  { channel: 'stable' },
)

Use polling when progress is not visible.

run submits and polls until a terminal status. Poll interval, timeout and backoff belong to client configuration.

const job = await nika.jobs.run('release.nika.yaml')
console.log(job.status, job.exit_code)

Separate job cancellation from request abort.

jobs.cancel asks the service to cancel work. AbortSignal stops the caller waiting on a request. Products often need both actions.

await nika.jobs.cancel(job_id)
const settled = await nika.jobs.status(job_id)

Keep this behind an adapter.

The namespace is useful for integration work, tests and UI design today. Do not route production work to it until a compatible service release is published.