Trigger async audit analysis job

Triggers an asynchronous audit analysis job. Requires that both business_analysis (document analysis) and interview_analysis records with is_current=true already exist for the project. Returns 202 with a job ID for polling. No request body required.

POST /api/agent/projects/{id}/audit-analysis/async

Trigger async audit analysis job

cURL

curl --request POST \
  --url https://app.auditynow.com/api/agent/projects/{id}/audit-analysis/async \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/agent/projects/{id}/audit-analysis/async"

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

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.auditynow.com/api/agent/projects/{id}/audit-analysis/async', 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/projects/{id}/audit-analysis/async",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/projects/{id}/audit-analysis/async"

	req, _ := http.NewRequest("POST", 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.post("https://app.auditynow.com/api/agent/projects/{id}/audit-analysis/async")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/agent/projects/{id}/audit-analysis/async")

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

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

response = http.request(request)
puts response.read_body

202

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

{
  "error": "Unauthorized"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {
    "estimatedCostUSD": 123,
    "limitUSD": 123
  }
}

{
  "error": "Feature not available on your tier",
  "currentTier": "solo",
  "requiredTier": "starter",
  "upgradeUrl": "https://app.auditynow.com/billing/upgrade"
}

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

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

{
  "error": "Document or interview analysis required but not found",
  "code": "PREREQUISITE_MISSING"
}

{
  "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 project's UUID.

Response

202

application/json

Job enqueued, polling available

data · object · required

Show child attributes