Skip to main content
Jobs report a top-level status and a list of batches. Each batch has a phase so you can track progress incrementally. 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "batches": [
    {
      "uid": "batch-abc123",
      "phase": "completed",
      "started_at": "2024-12-01T10:00:00Z",
      "finished_at": "2024-12-01T10:02:30Z"
    }
  ],
  "delivery": {
    "document.pdf": {
      "markdown_delivery": {
        "type": "s3-signed-url",
        "url": "https://..."
      },
      "images": {}
    }
  },
  "errors": null
}

​
Status enums

  • queued: The job was accepted and will start shortly.
  • running: Processing is in progress.
  • completed: All batches are finished and delivery details are available.

​
Batches and phases

Each job has one or more batches. For each batch:
  • uid: unique identifier
  • phase: one of queued, running, or completed
  • started_at, finished_at: optional timestamps
Track progress by counting how many batches are completed vs total. 
import { DataIngestionClient, DataIngestionConfig, JobStatus } from "@trelent/data-ingestion";

const client = new DataIngestionClient();

async function getProgress(jobId: string) {
  const status = await client.getJobStatus(jobId, { includeMarkdown: false });
  const total = status.batches.length;
  const completedBatches = status.batches.filter(b => b.phase === "completed").length;
  const isDone = status.status === JobStatus.Completed;
  return { 
    isDone,
    completedBatches, 
    total, 
    percent: total ? Math.round((completedBatches / total) * 100) : 0 
  };
}

​
Reading delivery details

When status is completed, delivery provides either S3 pointers or signed URLs keyed by the original input identifier.