Skip to main content
GET
/
v1
/
compounding
/
jobs
/
{job_run_id}
Get compounding job status
curl --request GET \
  --url https://app.nex.ai/api/developers/v1/compounding/jobs/{job_run_id} \
  --header 'Authorization: <api-key>'
{
  "job_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_type": "consolidation",
  "workspace_id": 123,
  "status": "accepted",
  "dry_run": true,
  "insights_scanned": 123,
  "insights_affected": 123,
  "candidates_created": 123,
  "errors": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123,
  "error_details": {}
}
This endpoint requires the record.read scope on your API key.

Overview

Returns the current state of a compounding job triggered with Trigger compounding job. Use this endpoint to poll for completion and retrieve the final job metrics.

Status Values

StatusMeaning
acceptedThe trigger request was accepted and queued
runningThe background compounding worker is processing the job
completedThe job finished successfully and final counts are available
failedThe job failed and error_details contains failure information

Example

curl "https://app.nex.ai/api/developers/v1/compounding/jobs/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "job_run_id": "550e8400-e29b-41d4-a716-446655440000",
  "job_type": "pattern_detection",
  "workspace_id": 12345,
  "status": "completed",
  "dry_run": false,
  "insights_scanned": 42,
  "insights_affected": 3,
  "candidates_created": 2,
  "errors": 0,
  "started_at": "2026-03-26T10:30:00Z",
  "completed_at": "2026-03-26T10:30:02Z",
  "duration_ms": 1200
}

Authorizations

Authorization
string
header
required

API key for authentication (format: "Bearer YOUR_API_KEY")

Path Parameters

job_run_id
string<uuid>
required

The compounding job run identifier returned by the trigger endpoint

Response

Job status

job_run_id
string<uuid>

Unique identifier for this compounding job

job_type
enum<string>

The compounding job type

Available options:
consolidation,
pattern_detection,
playbook_synthesis,
decay_sweep,
metrics
workspace_id
integer

Workspace ID the job belongs to

status
enum<string>

Current job status

Available options:
accepted,
running,
completed,
failed
dry_run
boolean

Whether the job is running in dry-run mode

insights_scanned
integer

Total number of insights evaluated during the job

insights_affected
integer

Number of insights modified by the job

candidates_created
integer

Number of candidates or rules created by the job

errors
integer

Number of errors recorded during the job

started_at
string<date-time>

When the job entered the system

completed_at
string<date-time>

When the job completed, if it has finished

duration_ms
integer

Total job duration in milliseconds after completion

error_details
object

Structured error payload for failed jobs

Last modified on March 26, 2026