Start a brief for a topic from the evidence alone.

Creates the brief with its evidence pack, target searches, questions and suggested internal links already filled in, and a plain outline built from the evidence. It spends no SoftSolz AI credits, which is the point: write the real outline yourself with your own model and PUT it back to /sites/{site_id}/briefs/{brief_id}.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

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

Body Params

topic_idinteger

Topic from GET /sites/{site_id}/content-gaps.

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.createBrief('<site_id>', {
  "topic_id": 41
});
console.log(result);

Credentials

Authorization

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

Response · 201

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