GET/api/v1/jobs/{job_id}

Get Job Status

Poll async job status and retrieve result when completed.

This unified endpoint serves all async operations including:

Health score calculations
Forensics analysis (logic audit, DCMA 14-point, etc.)
CPM calculations
Resource analysis
And all other async endpoints

Job Lifecycle:

queued - Job submitted, waiting for worker
processing - Worker executing job
completed - Job finished successfully, result available
failed - Job encountered error
cancelled - Job cancelled by user

Progress Tracking:

progress_percent: Overall progress (0-100)
checks_completed / total_checks: Granular progress for forensics endpoints

Polling Recommendations:

Initial delay: 5 seconds
Interval: 2-5 seconds
Exponential backoff for long-running jobs

Result Expiration:

Job results are stored for 24 hours
After expiration, job status returns 404

Request example

json

{
  "tasks": [
    {
      "id": "T1",
      "duration_days": 5
    }
  ]
}

Response example

json

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "created_at": "2025-01-08T12:00:00Z",
  "task_count": 5000,
  "progress_percent": 0,
  "endpoint_name": "forensics/logic-audit"
}

Response fields from OpenAPI contract

This table is generated from the endpoint response schema in openapi.json.

Field	Type	Required	Description
job_id	string	Required	Job identifier
status	string	Required	Status of an async job. Job lifecycle: 1. QUEUED - Job submitted to queue, waiting for worker 2. PROCESSING - Worker picked up job and is executing 3. COMPLETED - Job finished successfully 4. FAILED - Job encountered an error 5. CANCELLED - Job was cancelled by user before completion
created_at	string	Required	Job creation timestamp
started_at	string \| null	Optional	Job start timestamp
completed_at	string \| null	Optional	Job completion timestamp
task_count	integer	Required	Number of tasks in schedule
result	object \| null	Optional	Job result when completed
error	string \| null	Optional	Error message if failed
progress_percent	number \| null	Optional	Job progress percentage (if available)
endpoint_name	string \| null	Optional	Endpoint that submitted this job
checks_completed	integer \| null	Optional	Number of checks/steps completed (for forensics endpoints)
total_checks	integer \| null	Optional	Total number of checks/steps (for forensics endpoints)

Schema

json-schema

{
  "$ref": "#/components/schemas/JobStatusResponse"
}

Authentication

x-api-key header

Reference details

Operation ID: get_async_job_status_api_v1_jobs__job_id__get
Section: Jobs
Tags: Jobs

Was this page helpful?

Your feedback helps us improve docs, reference pages, and Playground flows.

Topic: Get Job Status · Page: /docs/api-reference/get_async_job_status_api_v1_jobs__job_id__get

Report an issue Suggest improvement

Terms Privacy Contact

Schedule analysis guidance. Not legal advice. You remain responsible for contract and agency compliance.