Read a page the way a visitor receives it, with partials stitched in.

Use it to check the final markup of a page. A path with no extension resolves to path.html; an empty path is the home page.

GEThttps://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/rendered

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

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

Query Params

pathstringrequired

Page path, e.g. index.html or about.

Response

Response Body

pathstringResolved path.

content_typestringMIME type of the rendered file.

is_binarybooleantrue for an uploaded asset (use url).

contentstring | nullPage text with every partial include expanded, as a visitor receives it.

urlstring | nullSigned URL when the file is binary.

Request

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

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

const result = await client.siteBuilder.getRenderedProjectPage('<id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "path": "string",
    "content_type": "string",
    "is_binary": true,
    "content": "string",
    "url": "string"
  }
}