POST/api/v1/health/score/async
Submit Async Health Score Job
Submit asynchronous health score calculation job for large schedules.
This endpoint queues a job for background processing and returns immediately with a job ID. Use the job status endpoint to poll for completion.
Use Cases:
- Schedules with 5,000-10,000+ tasks
- Batch processing of multiple schedules
- Integration with external systems via webhooks
Performance:
- Target completion: <30 seconds for 5,000 tasks
- Webhook delivery: <5 seconds after completion
- Job result TTL: 24 hours
Tier Limits:
- Free: 2,000 tasks
- Professional: 5,000 tasks
- Enterprise: 50,000 tasks
- Government: 100,000+ tasks
Webhook Delivery:
- Optional callback URL for result delivery
- Retry logic: 3 attempts with exponential backoff
- Events: job.completed, job.failed
Source: same score as POST /api/v1/health/score. The weights are not a cited standard.
Request example
jsonjson
{
"tasks": [
{
"id": "T1",
"duration_days": 5
}
]
}Request fields from OpenAPI contract
Required fields and the optional fields that change this call are listed here. The shared task model stays on the task schema guide.This table is generated from the endpoint schema in openapi.json.
| Field | Type | Required | Description |
|---|---|---|---|
| tasks | array<object> | Required | List of tasks (same format as synchronous endpoint) |
| callback_url | string | null | Optional | Webhook URL for result delivery (optional) |
| priority | string | Optional | Priority level for async jobs. Priority levels affect queue position: - HIGH: Critical jobs, processed first - NORMAL: Standard processing priority - LOW: Background jobs, processed when resources available |
| include_details | boolean | Optional | Include detailed task-level diagnostics and recommendations |
Response example
jsonjson
{
"score": 92,
"grade": "A"
}Response fields from OpenAPI contract
This table is generated from the endpoint response schema in openapi.json.
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Required | Documentation URL for the code: https://bellatorsi.com/problems/<slug>. |
| title | string | Required | Short summary of the problem type. |
| status | integer | Required | HTTP status code. |
| detail | string | Required | What went wrong in this request. |
| code | string | Required | Stable UPPER_SNAKE machine code. |
Schema
json-schema
{
"$ref": "#/components/schemas/ProblemDetails"
}Authentication
- API key required
Reference details
- Operation ID
- health_score_async
- Section
- Health
- Tags
- Health
- Playground link
- /playground?endpoint=%2Fapi%2Fv1%2Fhealth%2Fscore%2Fasync&method=post
Was this page helpful?
Your feedback helps us improve docs, reference pages, and Playground flows.
Topic: Submit Async Health Score Job · Page: /docs/api-reference/health_score_async