Write the outline for a brief with your own model.

Replaces the outline, title and summary. Build the sections from the evidence on the brief: the searches, the questions people actually asked, and the wording of any page that already exists. Do not put numbers in the outline and do not claim anything about competitors. The dashboard shows the result as written by your app. Spends no SoftSolz AI credits.

PUThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/briefs/{brief_id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

brief_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

titlestring

Suggested page title.

summarystring

One paragraph on what the page has to achieve.

url_suggestionstring

Where the page should live.

outlinearray of objects

The sections, in order.

statusstring

Move it along.

Response

Response Body

briefobjectA plan for one page: what it must cover, in what order, and which searches it is for. Written from Search Console evidence, never from a guess about what competitors do.

Request

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

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

const result = await client.seo.writeBrief('<site_id>', '<brief_id>', {
  "title": "What payroll software costs in 2026",
  "outline": [
    {
      "heading": "What payroll software costs",
      "intent": "Answer the price question in the first paragraph.",
      "questions": [
        "how much is payroll software"
      ]
    }
  ]
});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "brief": {}
  }
}