Skip to main content
POST
/
v1
/
prompts
/
{id}
/
report
Generate prompt analysis report
curl --request POST \
  --url https://api.example.com/v1/prompts/{id}/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contentId": "<string>",
  "html": "<string>",
  "metaDescription": "<string>",
  "title": "<string>"
}
'
{
  "chatgpt": {
    "brands": [
      {
        "category": "<string>",
        "count": 123,
        "name": "<string>"
      }
    ],
    "preview": "<string>",
    "recommendations": {
      "geoTopicsSuggestion": {
        "score": 123,
        "data": {},
        "items": [
          {}
        ]
      }
    },
    "score": 123,
    "sources": [
      {
        "category": "<string>",
        "domain": "<string>",
        "organicPosition": 123,
        "position": 123,
        "title": "<string>",
        "type": "<string>",
        "url": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

API key starting with sk_. Generate one in Settings > API Keys.

Path Parameters

id
string
required

Prompt ID.

Body

application/json
contentId
string

Content ID to score (fetches HTML automatically).

html
string

HTML content to score.

metaDescription
string

Meta description (optional). Accepted for forward compatibility but currently NOT factored into recommendations — the score is computed from title and html only.

title
string

Title of the content to score.

Response

200 - application/json

Default Response

chatgpt
object
required

ChatGPT report. Null when no ChatGPT analysis exists for this prompt.