Skip to main content
GET
/
v1
/
jobs
/
{job_id}
Get Job Status
curl --request GET \
  --url https://app.arahealth.io/v1/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://app.arahealth.io/v1/jobs/{job_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.arahealth.io/v1/jobs/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.arahealth.io/v1/jobs/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.arahealth.io/v1/jobs/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.arahealth.io/v1/jobs/{job_id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.arahealth.io/v1/jobs/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "job_id": "example_job_id_456",
  "status": "pending",
  "message": "Task is still processing"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}

​
Overview

Check the status of an extraction job using the job ID returned from the Extract endpoint. Use this to monitor the progress of your document extraction tasks.

​
Endpoint

GET https://app.arahealth.io/v1/jobs/{job_id}
Base URL: https://app.arahealth.io Path: /v1/jobs/{job_id} Method: GET Authentication: None required

​
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());

const jobId = 'your_job_id';

const response = await fetch(`https://app.arahealth.io/v1/jobs/${jobId}`, {
  method: 'GET'
});

const data = await response.json();
console.log(data);

import requests

job_id = "your_job_id"
url = f"https://app.arahealth.io/v1/jobs/{job_id}"

response = requests.get(url)
print(response.json())

curl -X GET https://app.arahealth.io/v1/jobs/your_job_id

​
Response

The response returns the current status of the job: 
{
  "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

JavaScript
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));
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your Alto Health API key

Path Parameters

​
job_id
string
required

Job identifier

Example:

"your_job_id"

Response

Job status retrieved successfully

​
job_id
string

Job identifier

Example:

"example_job_id_456"

​
status
enum<string>

Current status of the job

Available options:
pending,
processing,
completed,
failed
Example:

"pending"

​
message
string

Status message

Example:

"Task is still processing"