Read the scheduled AI check settings for a website.

Whether SoftSolz checks your monitored questions on a schedule, how often, with which models, the models the plan allows, the estimated checks and credits a month, and how much of the monthly check allowance is used. Changing the settings and starting a check happen in the dashboard. Spends no SoftSolz AI credits.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/ai-search/settings

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.

Response

Response Body

settingsobjectThe scheduled check settings for the website.

modelsarray of objectsModels that can be chosen.

estimateobjectWhat the schedule would use.

last_checked_atstring | nullWhen SoftSolz last checked.

next_check_atstring | nullWhen the next scheduled check is due.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/ai-search/settings \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Authorization

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": {
    "settings": {
      "enabled": false,
      "frequency": "monthly",
      "models": [],
      "mode": "web_search"
    },
    "models": [
      {
        "id": "gpt-4o",
        "label": "GPT-4o",
        "provider": "openai",
        "locked": false,
        "locked_reason": null
      }
    ],
    "estimate": {
      "checks_per_month": 40,
      "credits_per_month": null,
      "cap": {
        "checks_used": 12,
        "checks_limit": 100
      }
    },
    "last_checked_at": null,
    "next_check_at": null
  }
}