curl --request GET \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score \
--header 'API-KEY: <api-key>'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score"
headers = {"API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"calculated_at": "2026-05-27T10:23:11Z",
"factors": [
{
"covered_facts": [
"Surfer SEO is an SEO platform with a Content Editor."
],
"name": "facts_coverage",
"value": 62
},
{
"found": true,
"name": "introduction_covered_topics"
}
],
"score": 62,
"status": "ready"
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [],
"message": "The request conflicts with the current resource state.",
"reason": "conflict"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Get AI Search score
Returns the AI Search score (0–100), plus its status, calculated_at and factors. score is
present for ready and calculating, and null for loading, error, and unavailable.
factors breaks the score down. The facts_coverage factor reports how much of the AI Search
guidelines the content covers, and its covered_facts lists which facts those are. The
introduction_* factors each assess one aspect of the draft’s introduction.
GET /ai_search_guidelines returns the same factors next to the full fact list.
status values: ready once the score is calculated; loading while the first calculation is queued
or running (no prior score yet); calculating while a recalculation runs over a previously computed
score — the prior score is still returned so it can be shown as stale; error if calculation failed;
unavailable when no score can be produced for this editor.
The score is recalculated whenever the Content Editor’s content changes. Prefer the
content_editor.ai_search_score.calculated / .failed webhook for change events; status and
calculated_at are there for clients that can’t subscribe, or to re-sync after a dropped event.
calculated_at is the timestamp of the current score. It is null until the first calculation
completes — and is also null for a ready score that was last calculated before this field was
introduced (these are not backfilled; the timestamp populates on the next recalculation).
Rate limit: 10 requests/sec
curl --request GET \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score \
--header 'API-KEY: <api-key>'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score"
headers = {"API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"calculated_at": "2026-05-27T10:23:11Z",
"factors": [
{
"covered_facts": [
"Surfer SEO is an SEO platform with a Content Editor."
],
"name": "facts_coverage",
"value": 62
},
{
"found": true,
"name": "introduction_covered_topics"
}
],
"score": 62,
"status": "ready"
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [],
"message": "The request conflicts with the current resource state.",
"reason": "conflict"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Authorizations
Path Parameters
x >= 1123
x >= 1123
Response
AI Search score
When the current score was last calculated. null until the first calculation completes; also null for a ready score last calculated before this field existed (not backfilled — populates on the next recalculation).
"2026-05-27T10:23:11Z"
What the score is made of. Empty until the score has been calculated. The same factors are returned by GET /ai_search_guidelines, alongside the facts they refer to.
How much of the AI Search facts the content already states.
- AiSearchGuidelinesFactsCoverageFactor
- AiSearchGuidelinesIntroductionFactor
Show child attributes
Show child attributes
AI Search score, 0–100. Present when status is ready or calculating (the latter being the previous score while a fresh one is computed). null when status is loading, error, or unavailable.
0 <= x <= 10062
ready once the score is calculated; loading while the first calculation is queued or running (no prior score); calculating while a recalculation runs over a previously computed score (the prior score is still returned); error when calculation failed; unavailable when no score can be produced for this editor.
ready, loading, calculating, error, unavailable Was this page helpful?