Skip to main content
POST
/
api
/
agent
/
assessment-configs
Create a new assessment config template
curl --request POST \
  --url https://app.auditynow.com/api/agent/assessment-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manufacturing Readiness Template",
  "questionOrder": [
    "q1",
    "q2",
    "q5",
    "q10"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isTemplate": true,
    "questionOrder": [
      "<string>"
    ],
    "questionCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "hiddenQuestions": [
      "<string>"
    ],
    "scoringWeights": {},
    "defaultQuestionOverrides": {}
  }
}

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>.

Body

application/json
​
name
string
required

Name for this template.

Required string length: 1 - 100
​
questionOrder
string[] | null

Optional list of question IDs in desired order. Each entry must be a default question ID (e.g., q1, q2, q25) or a UUID. Defaults to full range if omitted.

Pattern: ^(q\d+|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Template created

​
data
object
required

An assessment configuration defining which questions are asked and how they are scored.