Jobs

Create worker jobs and track them through completion.

Jobs expose status, progress, retry count, deadline, output metadata, retention, and failure reason. Use /jobs for tools whose catalog entry marks API job creation as available.

States

queued

running

succeeded

failed

canceled

Create and inspect

Example

POST https://api.arconath.com/boringkit/v1/jobs
GET  https://api.arconath.com/boringkit/v1/jobs/{id}
GET  https://api.arconath.com/boringkit/v1/jobs?status=running
GET  https://api.arconath.com/boringkit/v1/jobs/{id}/download-intent
POST https://api.arconath.com/boringkit/v1/jobs/{id}/cancel
POST https://api.arconath.com/boringkit/v1/jobs/{id}/close

Create request

Example

{
  "toolSlug": "image-compress-api",
  "input": {
    "kind": "file",
    "name": "source.png",
    "contentType": "image/png",
    "sizeBytes": 2048000,
    "options": {
      "quality": 82
    }
  }
}

Accepted worker tools

html-to-pdf-api

Render basic HTML or a JSON HTML payload into a temporary PDF output. Text input can be supplied directly in the create request.

word-to-pdf

Convert DOCX or ODT documents to temporary PDF output.

slides-to-pdf

Convert PPTX or ODP slide decks to temporary PDF output.

spreadsheet-to-pdf

Convert XLSX, ODS, or CSV files to temporary PDF output.

pdf-to-images-zip

Render PDF pages to PNG files and package them as ZIP.

pdf-to-text

Extract machine-readable PDF text with scanner/OCR limitations reported in metadata.

pdf-to-markdown

Extract machine-readable PDF text into Markdown with quality metadata.

pdf-to-docx

Generate text-only DOCX from machine-readable PDF text.

image-compress-api

Compress PNG, JPEG, or WebP file input into optimized JPEG output. File input uses an upload intent.

trim-video

Trim MP4, QuickTime, or WebM input through the worker lane within size and duration limits.

compress-video

Compress MP4, QuickTime, or WebM input through the worker lane.

video-to-gif

Render short clips to GIF output through the worker lane.

mute-video

Remove audio from MP4, QuickTime, or WebM input through the worker lane.

Lifecycle behavior

idempotency

Send Idempotency-Key when creating jobs from retrying clients. Reuse the same key for the same intended job.

upload intent

File jobs return a PUT upload intent that expires quickly. Upload the exact content type and size you declared.

polling

Poll /jobs/{id} until status is succeeded, failed, or canceled. Do not create duplicate jobs just because output is not ready.

timeouts

Worker jobs include deadlineAt and maxAttempts. Timed-out jobs move to failed with an error reason.

cancellation

POST /jobs/{id}/cancel cancels queued or running jobs. Queued cancellations are fully refunded; running cancellations may keep one accepted-run credit.

close

POST /jobs/{id}/close hides the workspace row without deleting audit metadata or retained output metadata.

download

After success, call /jobs/{id}/download-intent and fetch the URL before output expiry.

Pages

Tool Kits