Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mnah05-boiler-go-21-79.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The worker ping endpoint enqueues a test task to verify that the worker system is operational and processing jobs correctly. This is useful for testing and monitoring worker health.

​
Endpoint

POST /worker/ping
Authentication: None required

​
Request

​
message
string
Optional custom message to include in the task payload. Defaults to “ping from API” if not provided.

​
Headers

​
X-Request-ID
string
Correlation ID for tracking the request through logs

​
Response

Returns HTTP 202 when the task is successfully queued, or an error status if queuing fails.
​
success
boolean
required
Indicates whether the task was successfully enqueued
​
task_id
string
required
Unique identifier for the enqueued task
​
task_type
string
required
Type of the task - will be “worker:ping”
​
queued_at
string
required
UTC timestamp when the task was queued
​
message
string
Additional information about the queued task

​
Response examples

{
  "success": true,
  "task_id": "01HX1234ABCD5678EFGH9012",
  "task_type": "worker:ping",
  "queued_at": "2026-03-03T14:32:15.456Z",
  "message": "Task queued successfully. Check worker logs to verify processing."
}

​
Example requests

curl -X POST http://localhost:8080/worker/ping

​
Task configuration

The ping task is configured with the following settings:
  • Queue: default
  • Max retries: 3
  • Timeout: 30 seconds
  • Request body limit: 1 MB