Documentation

Build background jobs with JobOrc

Plain-language guides for integrating the platform — not internal engineering specs.

TypeScript SDK

Package @joborc/sdk is the official thin client for enqueue and worker runtimes. Full examples live in the package README; this page is the public quick path.

Install

>_example.bash
BASH
pnpm add @joborc/sdk

Configure

>_example.bash
BASH
export JOBORC_API_KEY=jk_...
export JOBORC_PROJECT_ID=01a0...
export JOBORC_BASE_URL=https://api.your-domain.com # omit for default

Enqueue

>_example.ts
TS
import { createJobOrc } from '@joborc/sdk';
const joborc = createJobOrc({
apiKey: process.env.JOBORC_API_KEY!,
projectId: process.env.JOBORC_PROJECT_ID!,
});
await joborc.jobs.enqueue('reports.generate', { reportId: 'r1' }, {
queue: 'default',
idempotencyKey: 'report-r1',
});

Errors

API failures map to typed JOBORC-* errors from application/problem+json. Retry only transient transport errors; treat validation and auth failures as non-retryable.

See also Quickstart and CLI.