SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Write explanations for many findings in one call

Send up to 200 { finding_id, narrative, confidence } entries. Ids not in this report, duplicates and blank text are skipped and listed in skipped. only_missing=true leaves existing narratives alone. Spends no SoftSolz AI credits.

PUThttps://app.softsolz.uk/api/v1/services/seo/runs/{run_id}/narratives

Recent Requests

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

Path Params

run_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

narrativesarray of objectsrequired

Explanations keyed by finding id.

only_missingboolean

Skip findings that already have a narrative.

Response

Response Body

appliedintegerHow many findings were updated.
skippedarray of stringsFinding ids that were not applied.

Request

curl --request PUT \
--url https://app.softsolz.uk/api/v1/services/seo/runs/{run_id}/narratives \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"narratives": [
{
"finding_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"narrative": "Clicks fell from 120 to 80 because the page slipped from position 8.9 to 11.2, off page one.",
"confidence": 0.8
}
],
"only_missing": true
}'

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": {
"applied": 12,
"skipped": [
"..."
]
}
}