◉ Developer
API Reference
Run AI visibility scans programmatically. Pro plan required. Generate an API key →
Authentication
All API requests require a Bearer token in the Authorization header. Keys start with vz_live_.
Authorization: Bearer vz_live_<your-key>Rate limit: 60 requests per minute. Returns 429 with a Retry-After header on limit exceeded.
GET /api/v1/check
Run a full AI visibility scan on any domain. Returns robots.txt access, technical checks, discoverability signals, and an overall score.
Parameters
| domain* | string | The domain to scan. Accepts bare domains, URLs, or www-prefixed variants. |
Example request
curl "https://veezow.com/api/v1/check?domain=stripe.com" \
-H "Authorization: Bearer vz_live_<your-key>"Example response
{
"ok": true,
"result": {
"domain": "stripe.com",
"overallScore": 84,
"accessScore": 91,
"technicalScore": 88,
"discoverabilityScore": 73,
"bots": [
{ "bot": "GPTBot", "allowed": true, "rule": "allow" },
{ "bot": "ClaudeBot", "allowed": true, "rule": "allow" },
{ "bot": "PerplexityBot", "allowed": true, "rule": "allow" },
{ "bot": "Google-Extended","allowed": true, "rule": "allow" },
{ "bot": "CCBot", "allowed": true, "rule": "allow" }
],
"priorityFixes": [
{
"title": "Add Organization schema",
"impact": "high",
"description": "Missing name and url fields suppress entity disambiguation."
}
]
}
}Error codes
| Code | Meaning |
|---|---|
401 | Missing or invalid API token. |
400 | domain parameter missing or invalid. |
402 | Pro plan required to generate API keys. |
429 | Rate limit exceeded. Check Retry-After header. |
503 | Scan timed out. Retry in a moment. |
◉ Get started
Upgrade to Pro and generate your first API key from the account dashboard.