Skip to main content
POST
/
api
/
projects
/
{id}
/
audit-analysis
Trigger the audit synthesis pipeline
curl --request POST \
  --url https://app.auditynow.com/api/projects/{id}/audit-analysis \
  --header 'Authorization: Bearer <token>'
{
  "analysis": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "createdAt": "2023-11-07T05:31:56Z",
    "executiveSummary": "<string>",
    "opportunityCount": 123,
    "riskCount": 123,
    "synthesis": {}
  },
  "requestData": {},
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Audit synthesis complete. Body includes the saved analysis record and request metadata.

​
analysis
object
required
​
requestData
object

Echo of the synthesis input parameters used.

​
message
string