Developer Kit
Developer
API Console
Plan API-key scopes, job payloads, webhooks, polling, and worker output validation from one automation console.
Runs locally in your browser. No upload.
Paste input, choose an action, then copy or download the result.
API automation console
Build scoped job requests, validate payload shape, plan webhooks, and test the matching worker flow from a signed-in web session.
Create job request
curl -X POST "https://api.arconath.com/boringkit/v1/jobs" \
-H "Authorization: Bearer bk_...selected-key" \
-H "Content-Type: application/json" \
-d '
{
"toolSlug": "html-to-pdf-api",
"input": {
"kind": "text",
"contentType": "text/html",
"text": "<h1>Quarterly report</h1><p>Generated by BoringKit API.</p>",
"options": {
"pageSize": "A4",
"printBackground": true,
"waitUntil": "networkidle",
"margin": "16mm"
}
},
"webhookUrl": "https://example.com/webhooks/boringkit"
}
'
# Poll status
curl "https://api.arconath.com/boringkit/v1/jobs/{job_id}" \
-H "Authorization: Bearer bk_...selected-key"
# Create a temporary download intent after success
curl -X POST "https://api.arconath.com/boringkit/v1/jobs/{job_id}/download-intent" \
-H "Authorization: Bearer bk_...selected-key"Payload schema
{
"toolSlug": "html-to-pdf-api",
"input": {
"kind": "text",
"contentType": "text/html",
"text": "<h1>Quarterly report</h1><p>Generated by BoringKit API.</p>",
"options": {
"pageSize": "A4",
"printBackground": true,
"waitUntil": "networkidle",
"margin": "16mm"
}
},
"webhookUrl": "https://example.com/webhooks/boringkit"
}Webhook and polling contract
{
"event": "job.succeeded",
"delivery": {
"method": "POST",
"url": "https://example.com/webhooks/boringkit",
"retryPolicy": "exponential backoff with signed event ids"
},
"payload": {
"id": "job_123",
"toolSlug": "html-to-pdf-api",
"status": "succeeded",
"costUnits": "document-worker cost policy",
"output": {
"summary": "HTML rendered to PDF.",
"downloadIntent": {
"url": "https://temporary-download.example/output",
"expiresAt": "2026-05-08T02:00:00.000Z"
}
}
},
"failureClasses": [
"validation_failed",
"credit_denied",
"processing_timeout",
"worker_failed",
"output_validation_failed"
]
}Try from web session
Upload only when this worker-backed tool needs a temporary input object.
- Validation
- terminal status is succeeded · output MIME matches tool contract
- Retention
- Server inputs and outputs are temporary by default.
- Workspace
- Tracked job with download, cancel, and close actions
Job settings
pageSize: A4printBackground: truewaitUntil: networkidlemargin: 16mm
Job state
Queue, upload, progress, and final output readiness are shown here. You can leave this page; BoringKit keeps watching the job.
No job has been queued yet.
Choose a valid input and queue the job from this signed-in account.