Documentation

Sign up and get your project API token from the dashboard

Publish jobs, register workers, and orchestrate workflows

Publishing Jobs

Send jobs to the queue with data and options. Jobs can be fire-and-forget or request-response.

const jobId = await client.publish(
  'send-email',
  { to: 'user@example.com' }
);

Processing Jobs

Register worker functions that process jobs. Workers run concurrently and handle retries automatically.

client.work('send-email', async (job) => {
  await sendEmail(job.data);
  return { sent: true };
});

Request-Response

Wait for job completion and get results synchronously. Perfect for API integrations.

const result = await client.request(
  'calculate',
  { x: 5, y: 10 }
);

Workflows

Define multi-step workflows with dependencies. Steps execute in order based on dependencies.

await client.workflow('order', {
  'step1': async () => { 
    return { valid: true }; 
  },
  'step2': ['step1', async (results) => { 
    return { processed: true }; 
  }]
});