SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Write suggestions for a keyword with your own model

Replaces the suggestions on file. Send 2 to 5 suggestions, most valuable first; extras beyond five are dropped, titles are cut at 90 characters and details at 420. The dashboard shows them as written by your app. Spends no SoftSolz AI credits.

PUThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/keywords/{keyword_id}/advice

Recent Requests

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

Path Params

site_idstringrequired
keyword_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

suggestionsarray of objectsrequired

Up to five suggestions.

modelstring

Optional name of the model that wrote them, recorded as external:<model>.

Response

Response Body

idstringAdvice record id.
tracked_query_idstringKeyword the advice is for.
period_startstring | nullMonth the evidence was taken from.
evidence_jsonobjectThe Search Console numbers the advice was written from.
suggestions_jsonarray of objectsAt most five suggestions, most valuable first.
model_idstring | nullsoftsolz when SoftSolz wrote it, external when written through the API.
credits_usednumberSoftSolz AI credits spent. Always 0 through the API.
sourcestringsoftsolz or api.
author_labelstring | nullName of the app or key that wrote it.
created_atstringWhen the advice was last written.

Request

curl --request PUT \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/keywords/{keyword_id}/advice \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"suggestions": [
{
"title": "Add a step-by-step starter recipe",
"detail": "The page ranks 11th for a query with 1,900 monthly impressions; a recipe section answers the intent directly.",
"effort": "medium"
}
]
}'

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",
"tracked_query_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"period_start": "2026-08-01",
"evidence_json": {},
"suggestions_json": [
{
"title": "Add a step-by-step starter recipe",
"detail": "The page ranks 11th for a query with 1,900 monthly impressions...",
"effort": "low"
}
],
"model_id": "external",
"credits_used": 0,
"source": "api",
"author_label": "Claude",
"created_at": "2026-09-01T09:00:00.000Z"
}
}