Get Job Status

​

Overview

​

Endpoint

GET https://app.arahealth.io/v1/jobs/{job_id}

​

Path Parameters

• job_id (required) - The job identifier returned from the Extract endpoint

​

Code Examples

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://app.arahealth.io/v1/jobs/your_job_id");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

​

Response

{
  "job_id": "example_job_id_456",
  "status": "pending",
  "message": "Task is still processing"
}

​

Response Fields

• job_id - The job identifier
• status - Current status of the job:
  • pending - Job is queued and waiting to start
  • processing - Job is currently being processed
  • completed - Job has finished successfully
  • failed - Job encountered an error
• message - Descriptive message about the current status

​

Usage Flow

1. Upload a document using the Document Upload endpoint
2. Processing begins automatically, creating a job
3. Poll this endpoint periodically using the job_id to check the job status
4. When status is completed, the data extraction and pathway execution are complete

​

Example Polling Pattern

async function waitForJobCompletion(jobId) {
  while (true) {
    const response = await fetch(`https://app.arahealth.io/v1/jobs/${jobId}`);
    const data = await response.json();

    if (data.status === 'completed') {
      console.log('Job completed successfully!');
      return data;
    } else if (data.status === 'failed') {
      console.error('Job failed:', data.message);
      throw new Error(data.message);
    }

    // Wait 2 seconds before checking again
    await new Promise(resolve => setTimeout(resolve, 2000));
  }
}