Read one file as stored (partial includes not expanded).

For an uploaded asset the content is empty and url points at the bytes. 404 when the path does not exist.

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

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

Relative file path, e.g. index.html or css/base.css.

Response

Response Body

pathstringRelative file path.

is_binarybooleantrue for an uploaded asset (content is empty, use url).

contentstring | nullRaw file text as stored (partials not expanded).

urlstring | nullSigned URL to fetch an uploaded asset.

updated_atstringLast write to this file.

Request

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

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

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

Credentials

Authorization

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

Response · 200

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