SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Read the building guide before creating or editing a website

Call this first in a session. It returns the recommended workflow, the file model (pages at the root, shared chrome in partials/, css/base.css, js/, config.js), the design and code rules this workspace expects, the content guard (what a file may never contain), design-system markers, connectable integrations, limits and the concurrency rules. It never spends AI credits; you do the design work.

GEThttps://app.softsolz.uk/api/v1/services/site-builder/guide

Recent Requests

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

Headers

Authorizationstringrequired

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

Response

Response Body

workflowarray of stringsOrdered steps to build and publish a site through this API.
file_modelobjectWhere pages, partials, styles, scripts, config and assets live and how partials are included.
rulesarray of objectsDesign, code and SEO rules the workspace expects: { kind, title, content }.
content_guardobjectWhat a file may never contain and which public endpoints a site may call.
design_systemobjectManaged stylesheet markers, style names and required tokens.
integrationsobjectConnectable services, modes and how placement works.
limitsobjectFile, size and batch limits.
concurrencyobjectHow expected_version and site_busy work.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/site-builder/guide \
--header 'Authorization: Bearer sk_live_your_key'

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": {
"workflow": [],
"file_model": {},
"rules": [],
"content_guard": {},
"design_system": {},
"integrations": {},
"limits": {},
"concurrency": {}
}
}