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

TimeStatusUser Agent

Make a request to see history.

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 objects

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

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.writeRunNarratives('<run_id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "applied": 0,
    "skipped": []
  }
}