BoringKit
Pricing
Menu

Account

Sign in

Quickstart

Choose a tool, then run it the right way.

BoringKit tells you how each tool runs before you send work. Use the web UI for tools that stay in the browser, /url-metadata for public page metadata, and /jobs for API-capable worker tools.

1. List tool contracts

Example
curl https://api.arconath.com/boringkit/v1/tools

2. Check processing metadata

Example
curl https://api.arconath.com/boringkit/v1/processing/metadata

3. Fetch public URL metadata

Example
curl https://api.arconath.com/boringkit/v1/url-metadata \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com"
  }'

4. Create a worker job

Example
curl https://api.arconath.com/boringkit/v1/jobs \
  -X POST \
  -H "Authorization: Bearer $BORINGKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: html-to-pdf-demo-001" \
  -d '{
    "toolSlug": "html-to-pdf-api",
    "input": {
      "kind": "text",
      "contentType": "text/html",
      "text": "<h1>Invoice</h1><p>Thank you.</p>"
    }
  }'

File-based jobs return an upload intent first. Upload the file to that URL, then poll the job until it succeeds or fails.

5. Poll accepted jobs

Example
curl https://api.arconath.com/boringkit/v1/jobs/$JOB_ID \
  -H "Authorization: Bearer $BORINGKIT_API_KEY"

curl https://api.arconath.com/boringkit/v1/jobs/$JOB_ID/download-intent \
  -H "Authorization: Bearer $BORINGKIT_API_KEY"

Use this shape after a job has been accepted. Do not pre-upload files or assume a download exists for metadata-only, browser-only, or unavailable tools.