SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Render the report as Markdown.

Includes the narratives on file, so write them first if you want them in the document.

GEThttps://app.softsolz.uk/api/v1/services/seo/runs/{run_id}/report

Recent Requests

Log in to see full request history
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.

Response

Response Body

markdownstringThe full report.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.seo.getRunReport('<run_id>');
console.log(result);

Credentials

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

Response · 200

{
"data": {
"markdown": "string"
}
}