REST API

Trigger scans and retrieve results programmatically. All endpoints require a Bearer API key.

Authentication

Pass your API key as a Bearer token in every request. API access requires a Plus or Pro plan.

Authorization: Bearer cs_xxxxxxxxxxxxxxxx

Base URL

https://crawlit.eu

POST /api/v1/scan

Trigger a new AI visibility scan for a URL. Returns immediately with a UUID to poll for results.

Request body (JSON)

{
  "url": "https://example.com"
}

Response — 202 Accepted

{
  "uuid": "4f6e9a2b-...",
  "url": "https://example.com",
  "status": "pending"
}

Example

curl -X POST https://crawlit.eu/api/v1/scan \
  -H "Authorization: Bearer cs_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'

GET /api/v1/scans/:uuid

Retrieve the status and full results of a scan. Poll until status is done.

Response — 200 OK

{
  "uuid": "4f6e9a2b-...",
  "url": "https://example.com",
  "status": "done",
  "overall_score": 74,
  "results": [
    {
      "pillar": "indexing",
      "status": "done",
      "score": 85,
      "findings": [
        {
          "severity": "high",
          "title": "GPTBot is blocked in robots.txt",
          "description": "...",
          "recommendation": "..."
        }
      ]
    }
  ]
}

Example

curl https://crawlit.eu/api/v1/scans/4f6e9a2b-... \
  -H "Authorization: Bearer cs_xxxxxxxxxxxxxxxx"

Scan status values

Status	Meaning
`pending`	Scan queued, not yet started
`running`	Audit pillars are currently being processed
`done`	All pillars complete — results are final
`failed`	Scan could not be completed (unreachable URL, etc.)

Finding severity levels

Severity	Impact
`critical`	Blocks AI indexing or causes severe score deduction
`high`	Significant negative impact on AI visibility
`medium`	Moderate impact — should be addressed
`low`	Minor improvement opportunity
`info`	Informational — no score impact

Rate limits

Daily scan limits are enforced per API key. Exceeding the limit returns 429 Too Many Requests. Manage your keys in the API keys dashboard.