v2

latestOpenAPI 3.1.02026-08-0382170235.8 KB
jobs

Get job status

Get status of an ingestion job.

Poll this endpoint to track progress of async ingestion.

Job Lifecycle:

  • pending: Job queued, not started
  • processing: Job in progress (check progress field)
  • completed: Job finished successfully (check result field)
  • failed: Job failed (check error field)

M17 Phase Progress: When processing, the progress field includes:

  • phase: Current pipeline phase (extracting, indexing, detecting_edges, propagating_scores)
  • phase_index/phases_total: Phase position (e.g., 2/4)
  • phase_detail: Sub-step detail within the phase
  • overall_percent: Overall progress estimate (0-100)

The poll_interval_ms field suggests an appropriate polling interval.

get/jobs/{job_id}

Path parameters

job_idstring uuid required

Response

Job status retrieved

job_idstring uuid required
pot_idstring uuid required
status'pending' | 'processing' | 'completed' | 'failed' required

Job lifecycle states.

created_atstring date-time required
updated_atstring date-time required
poll_interval_msinteger nullable

Suggested polling interval in milliseconds

Example response

{
  "result": {
    "document_context": {
      "document_type": "technical",
      "key_entities": [
        "POT Index",
        "SciPot",
        "certainty scores",
        "facts",
        "provenance"
      ],
      "language": "en",
      "main_themes": [
        "scoring system",
        "knowledge validation",
        "certainty measurement"
      ],
      "title": "POT Index Specification"
    }
  }
}