Skip to main content
GET
Get AI Search guidelines for a Content Editor

Authorizations

API-KEY
string
header
required

Path Parameters

workspace_id
integer
required
Required range: x >= 1
Example:

123

content_editor_id
integer
required
Required range: x >= 1
Example:

123

Response

AI Search guidelines

inserted_at
string<date-time>
required
Example:

"2024-04-12T15:23:45Z"

factors
(AiSearchGuidelinesFactsCoverageFactor · object | AiSearchGuidelinesIntroductionFactor · object)[]
required

What the score is made of. Empty until the score has been calculated.

How much of the AI Search facts the content already states.

Example:
facts
AiSearchGuidelinesFact · object[]
required

Empty until status is completed.

id
integer
required
Required range: x >= 1
Example:

123

score
integer | null
required

AI Search score, 0–100. null until calculation finishes; recalculated whenever the Content Editor's content changes.

Example:

62

status
enum<string>
required

executing while SERP analysis or LLM merging is in progress. completed once both have settled and facts is final — LLM-only sources may be missing when the LLM merge failed. failed if SERP analysis failed.

Available options:
executing,
completed,
failed
updated_at
string<date-time>
Example:

"2024-06-01T09:17:33Z"