Poll async job status

Returns the status of an async job. Use to poll the result of /api/agent/projects/{id}/audit-analysis/async. Statuses are pending, processing, completed, or failed.

GET /api/agent/jobs/{id}

Poll async job status

cURL

curl --request GET \
  --url https://app.auditynow.com/api/agent/jobs/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/agent/jobs/{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.auditynow.com/api/agent/jobs/{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.auditynow.com/api/agent/jobs/{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.auditynow.com/api/agent/jobs/{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.auditynow.com/api/agent/jobs/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/agent/jobs/{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

200

{
  "data": {
    "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "analysisId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "error": "<string>",
    "errorCode": "<string>"
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Path Parameters

id · string<uuid> · required

The job's UUID.

Response

200

application/json

Job status

data · object · required

Status of an async job. Use the status enum (pending, processing, completed, failed) to determine next action.

Show child attributes