SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Write the explanation for one code finding

PUThttps://app.softsolz.uk/api/v1/services/seo/code/audits/{audit_id}/findings/{finding_id}/narrative

Recent Requests

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

Path Params

audit_idstringrequired
finding_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

narrativestringrequired

Two to four plain-English sentences explaining this finding for this repository and how to fix it. At most 2000 characters.

Response

Response Body

idstringCode finding id. Use it as finding_id under the audit.
check_idstringWhich check: title_present, title_length, description_present, description_length, viewport, lang, canonical, open_graph, structured_data, organization_schema, robots_txt, sitemap, llms_txt, security_txt and others.
categorystringGrouping of the check.
severitystringhigh, medium or low.
statusstringpass or fail.
scopestringsite for repository-wide checks, page for one file.
file_pathstring | nullRepository path of the page, when page-scoped.
page_pathstring | nullURL path the file renders.
titlestringWhat the check looks for.
detailstring | nullWhat was found.
fix_markdownstring | nullGeneric fix guidance, Markdown.
narrativestring | nullPlain-English explanation written for this repository.
narrative_sourcestring | nullsoftsolz or api.
narrative_authorstring | nullName of the app or key that wrote it.
evidence_jsonobjectFacts behind the finding.

Request

curl --request PUT \
--url https://app.softsolz.uk/api/v1/services/seo/code/audits/{audit_id}/findings/{finding_id}/narrative \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"narrative": "The home page has no meta description, so Google writes its own snippet. Add one in the head of src/pages/index.astro."
}'

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 · 200

{
"data": {
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"check_id": "description_present",
"category": "metadata",
"severity": "medium",
"status": "fail",
"scope": "page",
"file_path": "src/pages/index.astro",
"page_path": "/",
"title": "Meta description present",
"detail": "No <meta name=\"description\"> in the head.",
"fix_markdown": null,
"narrative": null,
"narrative_source": "api",
"narrative_author": "Claude",
"evidence_json": {}
}
}