SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Audit the repository code for search and AI readability

Reads the branch and runs the checks; no model is involved. Poll GET /code/audits/{audit_id} until status is completed, then read the findings and write fixes or narratives.

POSThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/code/repos/{repo_id}/audits

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired
repo_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

branchstring

Branch to read, default the repository default branch.

Response

Response Body

idstringAudit id. Use it as audit_id.
site_idstringWebsite audited.
repo_idstringRepository audited.
statusstringqueued, reading, auditing, completed or failed.
commit_shastring | nullCommit the audit read.
branchstring | nullBranch the audit read.
frameworkstring | nullFramework detected.
files_scannedintegerFiles read.
pages_scannedintegerPages checked.
passed_countintegerChecks that passed.
failed_countintegerChecks that failed.
scoreinteger | null0 to 100 health score.
summary_markdownstring | nullShort summary, Markdown.
error_messagestring | nullWhy the audit failed, when it did.
created_atstringWhen it was requested.
updated_atstringLast status change.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/code/repos/{repo_id}/audits \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"branch": "main"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 202

{
"data": {
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"site_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"repo_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"status": "completed",
"commit_sha": "9fceb02d",
"branch": "main",
"framework": "astro",
"files_scanned": 148,
"pages_scanned": 23,
"passed_count": 61,
"failed_count": 9,
"score": 72,
"summary_markdown": null,
"error_message": null,
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:00:00.000Z"
}
}