SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

List the content briefs for a website

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

Recent Requests

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

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

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

Query Params

statusstring

One of draft, approved, in_progress, published, discarded.

limitinteger

Page size, up to 200.

Response

Response Body · array of objects

idstringBrief id. Use it as brief_id.
site_idstringWebsite it belongs to.
topic_idinteger | nullTopic it covers.
target_page_idinteger | nullExisting page it rewrites, or null for a new page.
target_urlstring | nullThat page URL, when there is one.
statusstringWhere the brief stands.
titlestring | nullSuggested page title.
url_suggestionstring | nullWhere the page should live.
intentstring | nullWhat the reader wants.
summarystring | nullOne paragraph on what the page has to achieve.
generated_bystringrules when built from the evidence alone, model when SoftSolz shaped the outline, api when your app wrote it.
credits_usednumberSoftSolz AI credits spent. Always 0 over the API.
target_queries_jsonarray of stringsSearches the page is for.
questions_jsonarray of stringsQuestions to answer.
outline_jsonarray of objectsThe sections, in order.
internal_links_jsonarray of objectsPages of yours that already rank for the topic and should link to this one.
schema_suggestionsarray of stringsStructured data types that suit this page type.
evidence_jsonobjectEverything the brief was built from, so it can be checked.
author_labelstring | nullThe app that wrote it, when one did.
created_atstringWhen it was created.
updated_atstringLast change.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/briefs \
--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": [
{
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"site_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"topic_id": 41,
"target_page_id": 1335,
"target_url": null,
"status": "draft",
"title": "What payroll software costs in 2026",
"url_suggestion": "/payroll-software-pricing",
"intent": "transactional",
"summary": null,
"generated_by": "rules",
"credits_used": 0,
"target_queries_json": [
"payroll software cost"
],
"questions_json": [
"how much is payroll software"
],
"outline_json": [
{
"heading": "How much does payroll software cost?",
"intent": "Answer the price question plainly.",
"questions": [
"is payroll software worth it"
]
}
],
"internal_links_json": [
{
"url": "https://example.com/payroll",
"path": "/payroll",
"reason": "..."
}
],
"schema_suggestions": [
"FAQPage"
],
"evidence_json": {},
"author_label": "Claude",
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:00:00.000Z"
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}