API docs
Build practical automations with BoringKit.
Use BoringKit for utility workflows that need clear inputs, predictable output, and short-lived file handling. The API exposes tool metadata, scoped API keys, background jobs, download links, and account-safe automation features.
Keys
Create separate scoped keys for production, CI, and local testing.
Files
Upload only after a job returns a short-lived upload intent.
Jobs
Queue worker-backed tools, poll status, cancel active work, and download completed output.
AI
AI is shown only for concrete paid-plan actions with live proof.
What do you want to do?
Run a file job
Create a job, upload only when BoringKit returns an upload URL, then download the result before it expires.
Check API support
See which tools run locally, which use a URL endpoint, and which are available as API jobs.
Manage API keys
Create separate keys for production, CI, local development, and partner integrations.
Receive webhooks
Get signed completion events for Pro, Business, and Custom automation workflows.
Compare processing modes
Pick between browser-side tools, guarded URL checks, worker jobs, and API automation.
Start from a workflow template
Open a practical BoringKit utility sequence, then bring your own input and policy checks.
Recommended flow
1. Choose the tool
Read /tools or /tools/{slug}. The response lists accepted input types, limits, output types, file expiry, and whether API jobs are supported.
2. Run it the right way
Browser tools stay in the web app. URL checks use /url-metadata. File and automation jobs use /jobs.
3. Retrieve output on time
Poll /jobs/{id}, request a download intent after success, and copy results to your own storage before the retention window ends.
Quick request
curl https://api.arconath.com/boringkit/v1/tools \
-H "Authorization: Bearer $BORINGKIT_API_KEY"Core examples
Create a worker job
Use this for document, media, and API-capable tools. File jobs return an upload intent first, then a temporary download intent after success.
curl https://api.arconath.com/boringkit/v1/jobs \
-H "Authorization: Bearer $BORINGKIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"toolSlug": "word-to-pdf",
"input": {
"kind": "file",
"name": "brief.docx",
"contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"sizeBytes": 24576
}
}'Handle insufficient credits
Validation failures do not charge credits. Accepted browser, worker, and API runs are metered before processing starts, and credit denial returns a structured error.
{
"error": {
"code": "insufficient_credits",
"message": "not enough BoringKit credits: need 12, remaining 4",
"details": { "planId": "free", "costUnits": 12 }
}
}Cancel or close a job
Cancel queued/running work when possible. Close hides a workspace row without deleting audit metadata or retained output metadata.
curl -X POST https://api.arconath.com/boringkit/v1/jobs/job_123/cancel \
-H "Authorization: Bearer $BORINGKIT_API_KEY"
curl -X POST https://api.arconath.com/boringkit/v1/jobs/job_123/close \
-H "Authorization: Bearer $BORINGKIT_API_KEY"Webhook receiver shape
Pro, Business, and Custom integrations should verify signatures, dedupe event ids, then fetch the job before trusting output metadata.
{
"event": "job.succeeded",
"id": "evt_...",
"jobId": "job_...",
"toolSlug": "html-to-pdf-api",
"signature": "provided in the request header"
}Customer-facing API surface
Tool registry
GET /tools and GET /tools/{slug} describe available tools, accepted formats, limits, output types, file expiry, and API job support.
URL metadata
POST /url-metadata fetches public page metadata through a protected URL fetch for web and marketing checks.
Worker jobs
POST /jobs accepts API-capable worker tools including HTML to PDF, Image Compress, Trim Video, Compress Video, Video to GIF, and Mute Video.
Files
Accepted file jobs return upload intents. Completed jobs return download intents until output retention expires.
Account features
API keys are managed from Account. AI appears only where a supported signed-in flow provides a concrete action.
Execution model
In-browser tools
Text, data, PDF basics, image basics, business utilities, and security helpers process in the web UI without uploading input.
Metadata tools
Meta Tag Checker and Open Graph Preview can use /url-metadata when you want API-backed public page metadata.
Worker/API tools
Heavy or automation-oriented jobs run through /jobs with queue state, timeouts, temporary files, and downloadable output.
Guides
Quickstart
Make your first authenticated request and create an API job.
API keys
Generate, scope, rotate, and revoke keys from your account.
Authentication
Use bearer keys for API clients and account sessions for account features.
Tools catalog
Check which tools run in the browser, use URL metadata, or support API jobs.
Jobs
Create jobs, upload input when needed, poll status, cancel work, and download output.
Files
Use short-lived upload and download intents for worker-backed jobs.
AI policy
Understand when AI is exposed, hidden, or unavailable.
Webhooks
Design receivers for signed job-completion callbacks.
Rate limits
Plan retries and concurrency around bounded API usage.
File expiry
Know what is stored, what stays local, and when outputs expire.
Errors
Handle structured failures, validation errors, and retryable responses.
Production expectations
Idempotency
Send an Idempotency-Key on mutating requests that may be retried.
Least privilege
Create keys with the smallest scopes required by each integration.
Webhook verification
Verify signatures, dedupe event ids, and fetch the job before trusting payload data.
File expiry
Worker inputs expire in 1 hour and outputs expire in 24 hours by default. Move completed files to your own storage before expiry.
Provider agnostic billing
Checkout and credit adjustments describe the business behavior. The active payment provider, reseller, or Merchant of Record can change by environment.
AI visibility
AI is only shown when a tool has a concrete paid-plan AI action and live provider proof. Generic AI labels are intentionally hidden.